• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.form.formBindingData (卡片数据绑定类)
2
3卡片数据绑定模块提供卡片数据绑定的能力。包括FormBindingData对象的创建、相关信息的描述。
4
5> **说明：**
6>
7> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8
9## 导入模块
10
11```ts
12import formBindingData from '@ohos.app.form.formBindingData';
13```
14
15
16## ProxyData<sup>10+</sup>
17
18卡片代理刷新订阅数据信息。
19
20**模型约束：** 此接口仅可在Stage模型下使用。
21
22**系统能力**：SystemCapability.Ability.Form
23
24| 名称 | 类型 | 必填 | 说明 |
25| -------- | -------- | -------- | -------- |
26| key<sup>10+</sup> | string | 是 | 卡片代理刷新的订阅标识，与数据发布者保持一致。|
27| subscriberId<sup>10+</sup> | string | 否 | 卡片代理刷新的订阅条件，默认值为当前卡片的formId。|
28
29
30## FormBindingData
31
32FormBindingData相关描述。
33
34**系统能力**：SystemCapability.Ability.Form
35
36| 名称 | 类型 | 必填 | 说明 |
37| -------- | -------- | -------- | -------- |
38| data | Object | 是 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。|
39| proxies<sup>10+</sup> | Array<[ProxyData](#proxydata)> | 否 | 卡片代理刷新的订阅信息，默认为空数组。<br>**模型约束：** 此接口仅可在Stage模型下使用。<br>|
40
41## createFormBindingData
42
43createFormBindingData(obj?: Object | string): FormBindingData
44
45创建一个FormBindingData对象。
46
47**系统能力**：SystemCapability.Ability.Form
48
49**参数：**
50
51| 参数名 | 类型           | 必填 | 说明                                                         |
52| ------ | -------------- | ---- | ------------------------------------------------------------ |
53| obj    | Object\|string | 否   | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。其中图片数据以'formImages'作为标识，内容为图片标识与图片文件描述符的键值对{'formImages': {'key1': fd1, 'key2': fd2}} |
54
55
56**返回值：**
57
58| 类型                                | 说明                                    |
59| ----------------------------------- | --------------------------------------- |
60| [FormBindingData](#formbindingdata) | 根据传入数据创建的FormBindingData对象。 |
61
62
63**示例：**
64
65```ts
66import formBindingData from '@ohos.app.form.formBindingData';
67import fs from '@ohos.file.fs';
68import Base from '@ohos.base';
69
70try {
71  let fd = fs.openSync('/path/to/form.png');
72
73  let createFormBindingDataParam = new Map<string, string | Object>();
74  let formImagesParam = new Map<string, Object>();
75  formImagesParam.set('image', fd);
76  createFormBindingDataParam.set("name", '21°');
77  createFormBindingDataParam.set('formImages', formImagesParam);
78
79  formBindingData.createFormBindingData(createFormBindingDataParam);
80} catch (error) {
81  let code = (error as Base.BusinessError).code;
82  let message = (error as Base.BusinessError).message;
83  console.error(`catch error, code: ${code}, message: ${message}`);
84}
85```