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