• 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  let formId = '12400633174999288';
35  formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
36      if (error.code) {
37          console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
38      }
39  });
40  ```
41
42## setFormNextRefreshTime
43
44setFormNextRefreshTime(formId: string, minute: number): Promise<void>
45
46设置指定卡片的下一次更新时间,使用Promise异步回调。
47
48**系统能力:** SystemCapability.Ability.Form
49
50**参数:**
51
52  | 参数名 | 类型    | 必填 | 说明                                   |
53  | ------ | ------ | ---- | ------------------------------------- |
54  | formId | string | 是   | 卡片标识。                               |
55  | minute | number | 是   | 指定多久之后更新,单位分钟,大于等于5。     |
56
57**返回值:**
58
59  | 类型          | 说明                              |
60  | ------------- | ---------------------------------- |
61  | Promise\<void> | 无返回结果的Promise对象。      |
62
63**示例:**
64
65  ```ts
66  let formId = '12400633174999288';
67  formProvider.setFormNextRefreshTime(formId, 5).then(() => {
68      console.log('formProvider setFormNextRefreshTime success');
69  }).catch((error) => {
70      console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
71  });
72  ```
73
74## updateForm
75
76updateForm(formId: string, formBindingData: formBindingData.FormBindingData,callback: AsyncCallback&lt;void&gt;): void
77
78更新指定的卡片,使用callback异步回调。
79
80**系统能力:** SystemCapability.Ability.Form
81
82**参数:**
83
84  | 参数名 | 类型                                                                    | 必填 | 说明             |
85  | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
86  | formId | string                                                                 | 是   | 请求更新的卡片标识。 |
87  | formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是   | 用于更新的数据。    |
88  | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
89
90**示例:**
91
92  ```ts
93  import formBindingData from '@ohos.application.formBindingData';
94  let formId = '12400633174999288';
95  let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
96  formProvider.updateForm(formId, obj, (error, data) => {
97      if (error.code) {
98          console.log('formProvider updateForm, error:' + JSON.stringify(error));
99      }
100  });
101  ```
102
103## updateForm
104
105updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise&lt;void&gt;
106
107更新指定的卡片,使用Promise异步回调。
108
109**系统能力:** SystemCapability.Ability.Form
110
111**参数:**
112
113  | 参数名 | 类型                                                                    | 必填 | 说明             |
114  | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
115  | formId | string                                                                 | 是   | 请求更新的卡片标识。 |
116  | formBindingData.FormBindingData | [FormBindingData](js-apis-application-formBindingData.md#formbindingdat) | 是   | 用于更新的数据。    |
117
118**返回值:**
119
120| 类型           | 说明                                |
121| -------------- | ----------------------------------- |
122| Promise\<void> | 无返回结果的Promise对象。 |
123
124**示例:**
125
126  ```ts
127  import formBindingData from '@ohos.application.formBindingData';
128  let formId = '12400633174999288';
129  let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
130  formProvider.updateForm(formId, obj).then(() => {
131      console.log('formProvider updateForm success');
132  }).catch((error) => {
133      console.log('formProvider updateForm, error:' + JSON.stringify(error));
134  });
135  ```