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