js-apis-formprovider.md 4.7 KB
Newer Older
Z
zengyawen 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
# FormProvider

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

卡片提供方相关接口。

## 导入模块

```
import formProvider from '@ohos.application.formProvider';
```

## 权限



## setFormNextRefreshTime

L
liweifeng 已提交
20
setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback<void>): void;
Z
zengyawen 已提交
21 22 23 24 25 26 27 28 29 30 31 32 33

设置指定卡片的下一次更新时间。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

  | 参数名 | 类型    | 必填 | 说明                                   |
  | ------ | ------ | ---- | ------------------------------------- |
  | formId | string | 是   | 卡片标识                               |
  | minute | number | 是   | 指定多久之后更新,单位分钟,大于等于5     |
L
liweifeng 已提交
34
  | callback | AsyncCallback<void> | 是 | callback形式返回启动结果 |
Z
zengyawen 已提交
35 36 37 38 39 40

**示例:**

  ```js
  var formId = "12400633174999288";
  formProvider.setFormNextRefreshTime(formId, 5, (error, data) => {
L
liweifeng 已提交
41 42
      if (error.code) {
          console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
Z
zengyawen 已提交
43 44 45 46 47 48
      }
  });
  ```

## setFormNextRefreshTime

L
liweifeng 已提交
49
setFormNextRefreshTime(formId: string, minute: number): Promise<void>;
Z
zengyawen 已提交
50 51 52 53 54 55 56 57 58 59 60 61 62 63

设置指定卡片的下一次更新时间,以promise方式返回。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

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

R
RayShih 已提交
64 65 66 67 68 69
**返回值:**

  | 类型          | 说明                              |
  | ------------- | ---------------------------------- |
  | Promise\<void> |Promise实例,用于获取异步返回结果。      |

Z
zengyawen 已提交
70 71 72 73
**示例:**

  ```js
  var formId = "12400633174999288";
L
liweifeng 已提交
74 75 76
  formProvider.setFormNextRefreshTime(formId, 5).then(() => {
      console.log('formProvider setFormNextRefreshTime success');
  }).catch((error) => {
Z
zengyawen 已提交
77 78 79 80 81 82
      console.log('formProvider setFormNextRefreshTime, error:' + JSON.stringify(error));
  });
  ```

## updateForm

L
liweifeng 已提交
83
updateForm(formId: string, formBindingData: FormBindingData, callback: AsyncCallback&lt;void&gt;): void;
Z
zengyawen 已提交
84 85 86 87 88 89 90 91 92 93 94 95 96

更新指定的卡片。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

  | 参数名 | 类型                                                                    | 必填 | 说明             |
  | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
  | formId | string                                                                 | 是   | 请求更新的卡片标识 |
  | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是   | 用于更新的数据    |
L
liweifeng 已提交
97
  | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果 |
Z
zengyawen 已提交
98 99 100 101 102 103 104 105

**示例:**

  ```js
  import formBindingData from '@ohos.application.formBindingData';
  var formId = "12400633174999288";
  let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
  formProvider.updateForm(formId, obj, (error, data) => {
L
liweifeng 已提交
106 107
      if (error.code) {
          console.log('formProvider updateForm, error:' + JSON.stringify(error));
Z
zengyawen 已提交
108 109 110 111 112 113
      }
  });
  ```

## updateForm

L
liweifeng 已提交
114
updateForm(formId: string, formBindingData: FormBindingData): Promise&lt;void&gt;;
Z
zengyawen 已提交
115 116 117 118 119 120 121 122 123 124 125 126 127 128

更新指定的卡片,以promise方式返回。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

  | 参数名 | 类型                                                                    | 必填 | 说明             |
  | ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
  | formId | string                                                                 | 是   | 请求更新的卡片标识 |
  | formBindingData | [FormBindingData](js-apis-formbindingdata.md#formbindingdata) | 是   | 用于更新的数据    |

R
RayShih 已提交
129 130 131 132 133 134
**返回值:**

| 类型           | 说明                                |
| -------------- | ----------------------------------- |
| Promise\<void> | Promise实例,用于获取异步返回结果。 |

Z
zengyawen 已提交
135 136 137 138 139 140
**示例:**

  ```js
  import formBindingData from '@ohos.application.formBindingData';
  var formId = "12400633174999288";
  let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
L
liweifeng 已提交
141 142 143
  formProvider.updateForm(formId, obj).then(() => {
      console.log('formProvider updateForm success');
  }).catch((error) => {
Z
zengyawen 已提交
144 145 146
      console.log('formProvider updateForm, error:' + JSON.stringify(error));
  });
  ```