• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.application.formProvider (formProvider)
2
3FormProvider模块提供了卡片提供方相关接口的能力，开发者在开发卡片时，可通过该模块提供接口实现更新卡片，设置卡片更新时间，获取卡片信息，请求发布卡片等。
4
5> **说明：**
6> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
7> 从API version 9 开始不再维护，建议使用[formProvider](js-apis-app-form-formProvider.md)替代。
8
9## 导入模块
10
11```ts
12import formProvider from '@ohos.application.formProvider';
13```
14
15## setFormNextRefreshTime
16
17setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): void
18
19设置指定卡片的下一次更新时间，使用callback异步回调。
20
21**系统能力：** SystemCapability.Ability.Form
22
23**参数：**
24
25  | 参数名 | 类型    | 必填 | 说明                                   |
26  | ------ | ------ | ---- | ------------------------------------- |
27  | formId | string | 是   | 卡片标识。                               |
28  | minute | number | 是   | 指定多久之后更新。单位分钟，大于等于5。     |
29  | callback | AsyncCallback<void> | 是 | 回调函数。 |
30
31**示例：**
32
33  ```ts
34  import Base from '@ohos.base';
35  import formProvider from '@ohos.application.formProvider';
36
37  let formId: string = '12400633174999288';
38  formProvider.setFormNextRefreshTime(formId, 5, (error: Base.BusinessError) => {
39    if (error.code) {
40      console.error(`formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}`);
41    }
42  });
43  ```
44
45## setFormNextRefreshTime
46
47setFormNextRefreshTime(formId: string, minute: number): Promise<void>
48
49设置指定卡片的下一次更新时间，使用Promise异步回调。
50
51**系统能力：** SystemCapability.Ability.Form
52
53**参数：**
54
55  | 参数名 | 类型    | 必填 | 说明                                   |
56  | ------ | ------ | ---- | ------------------------------------- |
57  | formId | string | 是   | 卡片标识。                               |
58  | minute | number | 是   | 指定多久之后更新。单位分钟，大于等于5。     |
59
60**返回值：**
61
62  | 类型          | 说明                              |
63  | ------------- | ---------------------------------- |
64  | Promise\<void> | 无返回结果的Promise对象。      |
65
66**示例：**
67
68  ```ts
69  import Base from '@ohos.base';
70  import formProvider from '@ohos.application.formProvider';
71
72  let formId: string = '12400633174999288';
73  formProvider.setFormNextRefreshTime(formId, 5).then(() => {
74    console.log('formProvider setFormNextRefreshTime success');
75  }).catch((error: Base.BusinessError) => {
76    console.error(`formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}`);
77  });
78  ```
79
80## updateForm
81
82updateForm(formId: string, formBindingData: formBindingData.FormBindingData,callback: AsyncCallback&lt;void&gt;): void
83
84更新指定的卡片，使用callback异步回调。
85
86**系统能力：** SystemCapability.Ability.Form
87
88**参数：**
89
90  | 参数名 | 类型                                                                    | 必填 | 说明             |
91  | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
92  | formId | string                                                                 | 是   | 请求更新的卡片标识。 |
93  | formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是   | 用于更新的数据。    |
94  | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
95
96**示例：**
97
98  ```ts
99  import Base from '@ohos.base';
100  import formBindingData from '@ohos.application.formBindingData';
101  import formProvider from '@ohos.application.formProvider';
102
103  let formId: string = '12400633174999288';
104  let param: Record<string, string> = {
105    'temperature': '22c',
106    'time': '22:00'
107  }
108  let obj: formBindingData.FormBindingData = formBindingData.createFormBindingData(param);
109  formProvider.updateForm(formId, obj, (error: Base.BusinessError) => {
110    if (error.code) {
111      console.error(`formProvider updateForm, error: ${JSON.stringify(error)}`);
112    }
113  });
114  ```
115
116## updateForm
117
118updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise&lt;void&gt;
119
120更新指定的卡片，使用Promise异步回调。
121
122**系统能力：** SystemCapability.Ability.Form
123
124**参数：**
125
126  | 参数名 | 类型                                                                    | 必填 | 说明             |
127  | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
128  | formId | string                                                                 | 是   | 请求更新的卡片标识。 |
129  | formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata)  | 是   | 用于更新的数据。    |
130
131**返回值：**
132
133| 类型           | 说明                                |
134| -------------- | ----------------------------------- |
135| Promise\<void> | 无返回结果的Promise对象。 |
136
137**示例：**
138
139  ```ts
140  import Base from '@ohos.base';
141  import formBindingData from '@ohos.application.formBindingData';
142  import formProvider from '@ohos.application.formProvider';
143
144  let formId: string = '12400633174999288';
145  let param: Record<string, string> = {
146    'temperature': '22c',
147    'time': '22:00'
148  }
149  let obj: formBindingData.FormBindingData = formBindingData.createFormBindingData(param);
150  formProvider.updateForm(formId, obj).then(() => {
151    console.log('formProvider updateForm success');
152  }).catch((error: Base.BusinessError) => {
153    console.error(`formProvider updateForm, error: ${JSON.stringify(error)}`);
154  });
155  ```
156
157
158