• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# FormProvider
2
3> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
4> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
5
6卡片提供方相关接口。
7
8## 导入模块
9
10```
11import formProvider from '@ohos.application.formProvider';
12```
13
14## 权限
15
1617
18## setFormNextRefreshTime
19
20setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): void;
21
22设置指定卡片的下一次更新时间。
23
24**系统能力:**
25
26SystemCapability.Ability.Form
27
28**参数:**
29
30  | 参数名 | 类型    | 必填 | 说明                                   |
31  | ------ | ------ | ---- | ------------------------------------- |
32  | formId | string | 是   | 卡片标识                               |
33  | minute | number | 是   | 指定多久之后更新,单位分钟,大于等于5     |
34  | callback | AsyncCallback<void> | 是 | callback形式返回启动结果 |
35
36**示例:**
37
38  ```js
39  var formId = "12400633174999288";
40  formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
41      if (error.code) {
42          console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
43      }
44  });
45  ```
46
47## setFormNextRefreshTime
48
49setFormNextRefreshTime(formId: string, minute: number): Promise<void>;
50
51设置指定卡片的下一次更新时间,以promise方式返回。
52
53**系统能力:**
54
55SystemCapability.Ability.Form
56
57**参数:**
58
59  | 参数名 | 类型    | 必填 | 说明                                   |
60  | ------ | ------ | ---- | ------------------------------------- |
61  | formId | string | 是   | 卡片标识                               |
62  | minute | number | 是   | 指定多久之后更新,单位分钟,大于等于5     |
63
64**返回值:**
65
66  | 类型          | 说明                              |
67  | ------------- | ---------------------------------- |
68  | Promise\<void> |Promise实例,用于获取异步返回结果。      |
69
70**示例:**
71
72  ```js
73  var formId = "12400633174999288";
74  formProvider.setFormNextRefreshTime(formId, 5).then(() => {
75      console.log('formProvider setFormNextRefreshTime success');
76  }).catch((error) => {
77      console.log('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更新指定的卡片。
86
87**系统能力:**
88
89SystemCapability.Ability.Form
90
91**参数:**
92
93  | 参数名 | 类型                                                                    | 必填 | 说明             |
94  | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
95  | formId | string                                                                 | 是   | 请求更新的卡片标识 |
96  | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是   | 用于更新的数据    |
97  | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果 |
98
99**示例:**
100
101  ```js
102  import formBindingData from '@ohos.application.formBindingData';
103  var formId = "12400633174999288";
104  let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
105  formProvider.updateForm(formId, obj, (error, data) => {
106      if (error.code) {
107          console.log('formProvider updateForm, error:' + JSON.stringify(error));
108      }
109  });
110  ```
111
112## updateForm
113
114updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise&lt;void&gt;;
115
116更新指定的卡片,以promise方式返回。
117
118**系统能力:**
119
120SystemCapability.Ability.Form
121
122**参数:**
123
124  | 参数名 | 类型                                                                    | 必填 | 说明             |
125  | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
126  | formId | string                                                                 | 是   | 请求更新的卡片标识 |
127  | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是   | 用于更新的数据    |
128
129**返回值:**
130
131| 类型           | 说明                                |
132| -------------- | ----------------------------------- |
133| Promise\<void> | Promise实例,用于获取异步返回结果。 |
134
135**示例:**
136
137  ```js
138  import formBindingData from '@ohos.application.formBindingData';
139  var formId = "12400633174999288";
140  let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
141  formProvider.updateForm(formId, obj).then(() => {
142      console.log('formProvider updateForm success');
143  }).catch((error) => {
144      console.log('formProvider updateForm, error:' + JSON.stringify(error));
145  });
146  ```