js-apis-application-formProvider.md 5.1 KB
Newer Older
C
chenyuyan 已提交
1
# @ohos.application.formProvider (formProvider)
Z
zengyawen 已提交
2

3
FormProvider模块提供了卡片提供方相关接口的能力,开发者在开发卡片时,可通过该模块提供接口实现更新卡片,设置卡片更新时间,获取卡片信息,请求发布卡片等。
Y
yuyaozhi 已提交
4

Y
yuyaozhi 已提交
5
> **说明:**
Z
zengyawen 已提交
6
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
C
chenyuyan 已提交
7
> 从API version 9 开始不再维护,建议使用[formProvider](js-apis-app-form-formProvider.md)替代。
Z
zengyawen 已提交
8 9 10

## 导入模块

M
m00512953 已提交
11
```ts
Z
zengyawen 已提交
12 13 14 15 16
import formProvider from '@ohos.application.formProvider';
```

## setFormNextRefreshTime

17
setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): void
Z
zengyawen 已提交
18

19
设置指定卡片的下一次更新时间,使用callback异步回调。
Z
zengyawen 已提交
20

21
**系统能力:** SystemCapability.Ability.Form
Z
zengyawen 已提交
22 23 24 25 26

**参数:**

  | 参数名 | 类型    | 必填 | 说明                                   |
  | ------ | ------ | ---- | ------------------------------------- |
27 28 29
  | formId | string | 是   | 卡片标识。                               |
  | minute | number | 是   | 指定多久之后更新,单位分钟,大于等于5。     |
  | callback | AsyncCallback<void> | 是 | 回调函数。 |
Z
zengyawen 已提交
30 31 32

**示例:**

M
m00512953 已提交
33
  ```ts
M
mingxihua 已提交
34
  let formId = '12400633174999288';
Z
zengyawen 已提交
35
  formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
C
chenyuyan 已提交
36
    if (error.code) {
M
mingxihua 已提交
37
      console.error('formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}');
C
chenyuyan 已提交
38
    }
Z
zengyawen 已提交
39 40 41 42 43
  });
  ```

## setFormNextRefreshTime

44
setFormNextRefreshTime(formId: string, minute: number): Promise<void>
Z
zengyawen 已提交
45

46
设置指定卡片的下一次更新时间,使用Promise异步回调。
Z
zengyawen 已提交
47

48
**系统能力:** SystemCapability.Ability.Form
Z
zengyawen 已提交
49 50 51 52 53

**参数:**

  | 参数名 | 类型    | 必填 | 说明                                   |
  | ------ | ------ | ---- | ------------------------------------- |
54 55
  | formId | string | 是   | 卡片标识。                               |
  | minute | number | 是   | 指定多久之后更新,单位分钟,大于等于5。     |
Z
zengyawen 已提交
56

R
RayShih 已提交
57 58 59 60
**返回值:**

  | 类型          | 说明                              |
  | ------------- | ---------------------------------- |
61
  | Promise\<void> | 无返回结果的Promise对象。      |
R
RayShih 已提交
62

Z
zengyawen 已提交
63 64
**示例:**

M
m00512953 已提交
65
  ```ts
M
mingxihua 已提交
66
  let formId = '12400633174999288';
L
liweifeng 已提交
67
  formProvider.setFormNextRefreshTime(formId, 5).then(() => {
C
chenyuyan 已提交
68
    console.log('formProvider setFormNextRefreshTime success');
L
liweifeng 已提交
69
  }).catch((error) => {
M
mingxihua 已提交
70
    console.error('formProvider setFormNextRefreshTime, error: ${JSON.stringify(error)}');
Z
zengyawen 已提交
71 72 73 74 75
  });
  ```

## updateForm

76
updateForm(formId: string, formBindingData: formBindingData.FormBindingData,callback: AsyncCallback&lt;void&gt;): void
Z
zengyawen 已提交
77

78
更新指定的卡片,使用callback异步回调。
Z
zengyawen 已提交
79

80
**系统能力:** SystemCapability.Ability.Form
Z
zengyawen 已提交
81 82 83 84 85

**参数:**

  | 参数名 | 类型                                                                    | 必填 | 说明             |
  | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
86
  | formId | string                                                                 | 是   | 请求更新的卡片标识。 |
C
chenyuyan 已提交
87
  | formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是   | 用于更新的数据。    |
88
  | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
Z
zengyawen 已提交
89 90 91

**示例:**

M
m00512953 已提交
92
  ```ts
93
  import formBindingData from '@ohos.app.form.formBindingData';
C
chenyuyan 已提交
94

M
mingxihua 已提交
95 96
  let formId = '12400633174999288';
  let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
Z
zengyawen 已提交
97
  formProvider.updateForm(formId, obj, (error, data) => {
C
chenyuyan 已提交
98
    if (error.code) {
M
mingxihua 已提交
99
      console.error('formProvider updateForm, error: ${JSON.stringify(error)}');
C
chenyuyan 已提交
100
    }
Z
zengyawen 已提交
101 102 103 104 105
  });
  ```

## updateForm

106
updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise&lt;void&gt;
Z
zengyawen 已提交
107

108
更新指定的卡片,使用Promise异步回调。
Z
zengyawen 已提交
109

110
**系统能力:** SystemCapability.Ability.Form
Z
zengyawen 已提交
111 112 113 114 115

**参数:**

  | 参数名 | 类型                                                                    | 必填 | 说明             |
  | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
116
  | formId | string                                                                 | 是   | 请求更新的卡片标识。 |
C
chenyuyan 已提交
117
  | formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata)  | 是   | 用于更新的数据。    |
Z
zengyawen 已提交
118

R
RayShih 已提交
119 120 121 122
**返回值:**

| 类型           | 说明                                |
| -------------- | ----------------------------------- |
123
| Promise\<void> | 无返回结果的Promise对象。 |
R
RayShih 已提交
124

Z
zengyawen 已提交
125 126
**示例:**

M
m00512953 已提交
127
  ```ts
Z
zengyawen 已提交
128
  import formBindingData from '@ohos.application.formBindingData';
C
chenyuyan 已提交
129

M
mingxihua 已提交
130 131
  let formId = '12400633174999288';
  let obj = formBindingData.createFormBindingData({temperature:'22c', time:'22:00'});
L
liweifeng 已提交
132
  formProvider.updateForm(formId, obj).then(() => {
C
chenyuyan 已提交
133
    console.log('formProvider updateForm success');
L
liweifeng 已提交
134
  }).catch((error) => {
M
mingxihua 已提交
135
    console.error('formProvider updateForm, error: ${JSON.stringify(error)}');
Z
zengyawen 已提交
136
  });
137 138 139
  ```