js-apis-formhost.md 27.9 KB
Newer Older
L
liweifeng 已提交
1 2 3 4 5
# FormHost

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

6
卡片使用方相关接口。
L
liweifeng 已提交
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

## 导入模块

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

## 权限

ohos.permission.REQUIRE_FORM

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

## deleteForm

deleteForm(formId: string, callback: AsyncCallback<void>): void;

删除指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务不再保留有关该卡片的信息。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
32 33 34 35
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formId | string | 是   | 卡片标识 |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
36 37 38 39 40 41

**示例:**

  ```js
  var formId = "12400633174999288";
  formHost.deleteForm(formId, (error, data) => {
L
liweifeng 已提交
42 43
      if (error.code) {
          console.log('formHost deleteForm, error:' + JSON.stringify(error));
L
liweifeng 已提交
44 45 46 47 48 49 50 51 52 53
      }
  });
  ```

## deleteForm

deleteForm(formId: string): Promise<void>;

删除指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务不再保留有关该卡片的信息。

L
liweifeng 已提交
54 55 56 57
**系统能力:**

SystemCapability.Ability.Form

L
liweifeng 已提交
58 59 60 61 62 63
**参数:**

  | 参数名 | 类型    | 必填 | 说明    |
  | ------ | ------ | ---- | ------- |
  | formId | string | 是   | 卡片标识 |

L
liweifeng 已提交
64
**返回值:**
L
liweifeng 已提交
65

L
liweifeng 已提交
66 67 68
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |
L
liweifeng 已提交
69 70 71 72 73

**参数:**

  ```js
  var formId = "12400633174999288";
L
liweifeng 已提交
74 75 76
  formHost.deleteForm(formId).then(() => {
      console.log('formHost deleteForm success');
  }).catch((error) => {
Y
yangzk 已提交
77
      console.log('formHost deleteForm, error:' + JSON.stringify(error));
L
liweifeng 已提交
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
  });
  ```

## releaseForm

releaseForm(formId: string, callback: AsyncCallback<void>): void;

释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,但卡片管理器服务仍然保留有关该卡片的缓存信息和存储信息。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
93 94 95 96
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formId | string | 是   | 卡片标识 |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
97 98 99 100 101 102

**示例:**

  ```js
  var formId = "12400633174999288";
  formHost.releaseForm(formId, (error, data) => {
L
liweifeng 已提交
103 104
      if (error.code) {
          console.log('formHost releaseForm, error:' + JSON.stringify(error));
L
liweifeng 已提交
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
      }
  });
  ```

## releaseForm

releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback<void>): void;

释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务保留有关该卡片的存储信息,可以选择是否保留缓存信息。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
121 122 123 124 125
| 参数名         | 类型     | 必填 | 说明        |
| -------------- | ------  | ---- | ----------- |
| formId         | string  | 是   | 卡片标识     |
| isReleaseCache | boolean | 是   | 是否释放缓存 |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
126 127 128 129 130 131

**示例:**

  ```js
  var formId = "12400633174999288";
  formHost.releaseForm(formId, true, (error, data) => {
L
liweifeng 已提交
132 133
      if (error.code) {
          console.log('formHost releaseForm, error:' + JSON.stringify(error));
L
liweifeng 已提交
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
      }
  });
  ```

## releaseForm

releaseForm(formId: string, isReleaseCache?: boolean): Promise<void>;

释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务保留有关该卡片的存储信息,可以选择是否保留缓存信息。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

  | 参数名         | 类型     | 必填 | 说明        |
  | -------------- | ------  | ---- | ----------- |
  | formId         | string  | 是   | 卡片标识     |
  | isReleaseCache | boolean | 否   | 是否释放缓存 |

L
liweifeng 已提交
155 156 157 158 159
**返回值:**

  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |
L
liweifeng 已提交
160 161 162 163 164

**示例:**

  ```js
  var formId = "12400633174999288";
L
liweifeng 已提交
165 166 167
  formHost.releaseForm(formId, true).then(() => {
      console.log('formHost releaseForm success');
  }).catch((error) => {
Y
yangzk 已提交
168
      console.log('formHost releaseForm, error:' + JSON.stringify(error));
L
liweifeng 已提交
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
  });
  ```

## requestForm

requestForm(formId: string, callback: AsyncCallback<void>): void;

请求卡片更新。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
184 185 186 187
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formId | string | 是   | 卡片标识 |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
188 189 190 191 192 193

**示例:**

  ```js
  var formId = "12400633174999288";
  formHost.requestForm(formId, (error, data) => {
L
liweifeng 已提交
194 195
      if (error.code) {
          console.log('formHost requestForm, error:' + JSON.stringify(error));
L
liweifeng 已提交
196 197 198 199 200 201 202 203 204 205
      }
  });
  ```

## requestForm

requestForm(formId: string): Promise<void>;

请求卡片更新。

L
liweifeng 已提交
206 207 208 209
**系统能力:**

SystemCapability.Ability.Form

L
liweifeng 已提交
210 211 212 213 214 215
**参数:**

  | 参数名 | 类型    | 必填 | 说明    |
  | ------ | ------ | ---- | ------- |
  | formId | string | 是   | 卡片标识 |

L
liweifeng 已提交
216
**返回值:**
L
liweifeng 已提交
217

L
liweifeng 已提交
218 219 220
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |
L
liweifeng 已提交
221 222 223 224 225

**示例:**

  ```js
  var formId = "12400633174999288";
L
liweifeng 已提交
226 227 228
  formHost.requestForm(formId).then(() => {
      console.log('formHost requestForm success');
  }).catch((error) => {
Y
yangzk 已提交
229
      console.log('formHost requestForm, error:' + JSON.stringify(error));
L
liweifeng 已提交
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
  });
  ```

## castTempForm

castTempForm(formId: string, callback: AsyncCallback<void>): void;

将指定的临时卡片转换为普通卡片。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
245 246 247 248
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formId | string | 是   | 卡片标识 |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
249 250 251 252 253 254

**示例:**

  ```js
  var formId = "12400633174999288";
  formHost.castTempForm(formId, (error, data) => {
L
liweifeng 已提交
255 256
      if (error.code) {
          console.log('formHost castTempForm, error:' + JSON.stringify(error));
L
liweifeng 已提交
257 258 259 260 261 262 263 264 265 266
      }
  });
  ```

## castTempForm

castTempForm(formId: string): Promise<void>;

将指定的临时卡片转换为普通卡片。

L
liweifeng 已提交
267 268 269 270
**系统能力:**

SystemCapability.Ability.Form

L
liweifeng 已提交
271 272 273 274 275 276
**参数:**

  | 参数名 | 类型    | 必填 | 说明    |
  | ------ | ------ | ---- | ------- |
  | formId | string | 是   | 卡片标识 |

L
liweifeng 已提交
277
**返回值:**
L
liweifeng 已提交
278

L
liweifeng 已提交
279 280 281
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |
L
liweifeng 已提交
282 283 284 285 286

**示例:**

  ```js
  var formId = "12400633174999288";
L
liweifeng 已提交
287 288 289
  formHost.castTempForm(formId).then(() => {
      console.log('formHost castTempForm success');
  }).catch((error) => {
Y
yangzk 已提交
290
      console.log('formHost castTempForm, error:' + JSON.stringify(error));
L
liweifeng 已提交
291 292 293 294 295
  });
  ```

## notifyVisibleForms

Y
yangzk 已提交
296
notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void>): void;
L
liweifeng 已提交
297 298 299 300 301 302 303 304 305

向卡片框架发送通知以使指定的卡片可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
306 307 308 309
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds  | Array<string>       | 是   | 卡片标识列表         |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
310 311 312 313 314 315

**示例:**

  ```js
  var formId = "12400633174999288";
  formHost.notifyVisibleForms(formId, (error, data) => {
L
liweifeng 已提交
316 317
      if (error.code) {
          console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error));
L
liweifeng 已提交
318 319 320 321 322 323
      }
  });
  ```

## notifyVisibleForms

Y
yangzk 已提交
324
notifyVisibleForms(formIds: Array<string>): Promise<void>;
L
liweifeng 已提交
325 326 327

向卡片框架发送通知以使指定的卡片可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。

L
liweifeng 已提交
328 329 330 331
**系统能力:**

SystemCapability.Ability.Form

L
liweifeng 已提交
332 333
**参数:**

Y
yangzk 已提交
334 335 336
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是   | 卡片标识列表 |
L
liweifeng 已提交
337

L
liweifeng 已提交
338
**返回值:**
L
liweifeng 已提交
339

L
liweifeng 已提交
340 341 342
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |
L
liweifeng 已提交
343 344 345 346 347

**示例:**

  ```js
  var formId = "12400633174999288";
L
liweifeng 已提交
348 349 350
  formHost.notifyVisibleForms(formId).then(() => {
      console.log('formHost notifyVisibleForms success');
  }).catch((error) => {
Y
yangzk 已提交
351
      console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error));
L
liweifeng 已提交
352 353 354 355 356
  });
  ```

## notifyInvisibleForms

Y
yangzk 已提交
357
notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<void>): void;
L
liweifeng 已提交
358 359 360 361 362 363 364 365 366

向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
367 368 369 370
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds  | Array<string>       | 是   | 卡片标识列表         |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
371 372 373 374 375 376

**示例:**

  ```js
  var formId = "12400633174999288";
  formHost.notifyInvisibleForms(formId, (error, data) => {
L
liweifeng 已提交
377 378
      if (error.code) {
          console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error));
L
liweifeng 已提交
379 380 381 382 383 384
      }
  });
  ```

## notifyInvisibleForms

Y
yangzk 已提交
385
notifyInvisibleForms(formIds: Array<string>): Promise<void>;
L
liweifeng 已提交
386 387 388

向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。

L
liweifeng 已提交
389 390 391 392
**系统能力:**

SystemCapability.Ability.Form

L
liweifeng 已提交
393 394
**参数:**

Y
yangzk 已提交
395 396 397
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是   | 卡片标识列表 |
L
liweifeng 已提交
398

L
liweifeng 已提交
399
**返回值:**
L
liweifeng 已提交
400

L
liweifeng 已提交
401 402 403
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |
L
liweifeng 已提交
404 405 406 407 408

**示例:**

  ```js
  var formId = "12400633174999288";
L
liweifeng 已提交
409 410 411
  formHost.notifyInvisibleForms(formId).then(() => {
      console.log('formHost notifyInvisibleForms success');
  }).catch((error) => {
Y
yangzk 已提交
412
      console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error));
L
liweifeng 已提交
413 414 415 416 417
  });
  ```

## enableFormsUpdate

Y
yangzk 已提交
418
enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void>): void;
L
liweifeng 已提交
419 420 421 422 423 424 425 426 427

向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后,卡片刷新状态设置为使能,卡片可以接收来自卡片提供方的更新。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
428 429 430 431
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds  | Array<string>       | 是   | 卡片标识列表         |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
432 433 434 435 436 437

**示例:**

  ```js
  var formId = "12400633174999288";
  formHost.enableFormsUpdate(formId, (error, data) => {
L
liweifeng 已提交
438 439
      if (error.code) {
          console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error));
L
liweifeng 已提交
440 441 442 443 444 445
      }
  });
  ```

## enableFormsUpdate

Y
yangzk 已提交
446
enableFormsUpdate(formIds: Array<string>): Promise<void>;
L
liweifeng 已提交
447 448 449

向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后,卡片刷新状态设置为使能,卡片可以接收来自卡片提供方的更新。

L
liweifeng 已提交
450 451 452 453
**系统能力:**

SystemCapability.Ability.Form

L
liweifeng 已提交
454 455
**参数:**

Y
yangzk 已提交
456 457 458
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是   | 卡片标识列表 |
L
liweifeng 已提交
459

L
liweifeng 已提交
460
**返回值:**
L
liweifeng 已提交
461

L
liweifeng 已提交
462 463 464
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |
L
liweifeng 已提交
465 466 467 468 469

**示例:**

  ```js
  var formId = "12400633174999288";
L
liweifeng 已提交
470 471 472
  formHost.enableFormsUpdate(formId).then(() => {
      console.log('formHost enableFormsUpdate success');
  }).catch((error) => {
Y
yangzk 已提交
473
      console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error));
L
liweifeng 已提交
474 475 476 477 478
  });
  ```

## disableFormsUpdate

Y
yangzk 已提交
479
disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void>): void;
L
liweifeng 已提交
480 481 482 483 484 485 486 487 488

向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后,卡片刷新状态设置为去使能,卡片不可以接收来自卡片提供方的更新。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
489 490 491 492
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds  | Array<string>       | 是   | 卡片标识列表         |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
493 494 495 496 497 498

**示例:**

  ```js
  var formId = "12400633174999288";
  formHost.disableFormsUpdate(formId, (error, data) => {
L
liweifeng 已提交
499 500
      if (error.code) {
          console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error));
L
liweifeng 已提交
501 502 503 504 505 506
      }
  });
  ```

## disableFormsUpdate

Y
yangzk 已提交
507
disableFormsUpdate(formIds: Array<string>): Promise<void>;
L
liweifeng 已提交
508 509 510

向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后,卡片刷新状态设置为去使能,卡片不可以接收来自卡片提供方的更新。

L
liweifeng 已提交
511 512 513 514
**系统能力:**

SystemCapability.Ability.Form

L
liweifeng 已提交
515 516
**参数:**

Y
yangzk 已提交
517 518 519
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是   | 卡片标识列表 |
L
liweifeng 已提交
520

L
liweifeng 已提交
521
**返回值:**
L
liweifeng 已提交
522

L
liweifeng 已提交
523 524 525
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |
L
liweifeng 已提交
526 527 528 529 530

**示例:**

  ```js
  var formId = "12400633174999288";
L
liweifeng 已提交
531 532 533
  formHost.disableFormsUpdate(formId).then(() => {
      console.log('formHost disableFormsUpdate success');
  }).catch((error) => {
Y
yangzk 已提交
534
      console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error));
L
liweifeng 已提交
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
  });
  ```

## isSystemReady

isSystemReady(callback: AsyncCallback<void>): void;

检查系统是否准备好。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
550 551 552
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
553 554 555 556 557 558

**示例:**

  ```js
  var formId = "12400633174999288";
  formHost.isSystemReady((error, data) => {
L
liweifeng 已提交
559 560
      if (error.code) {
          console.log('formHost isSystemReady, error:' + JSON.stringify(error));
L
liweifeng 已提交
561 562 563 564 565 566 567 568 569 570 571 572 573 574
      }
  });
  ```

## isSystemReady

isSystemReady(): Promise<void>;

检查系统是否准备好。

**系统能力:**

SystemCapability.Ability.Form

L
liweifeng 已提交
575 576 577 578 579 580
**返回值:**

  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |

L
liweifeng 已提交
581 582 583 584
**示例:**

  ```js
  var formId = "12400633174999288";
L
liweifeng 已提交
585 586 587
  formHost.isSystemReady().then(() => {
      console.log('formHost isSystemReady success');
  }).catch((error) => {
Y
yangzk 已提交
588
      console.log('formHost isSystemReady, error:' + JSON.stringify(error));
L
liweifeng 已提交
589 590 591 592 593
  });
  ```

## getAllFormsInfo

594
getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void;
L
liweifeng 已提交
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611

获取设备上所有应用提供的卡片信息。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

  | 参数名 | 类型    | 必填 | 说明    |
  | ------ | ------ | ---- | ------- |
  | callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | callback形式返回查询到的卡片信息 |

**示例:**

  ```js
  formHost.getAllFormsInfo((error, data) => {
L
liweifeng 已提交
612 613 614 615
      if (error.code) {
          console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error));
      } else {
          console.log('formHost getAllFormsInfo, data:' + JSON.stringify(data));
L
liweifeng 已提交
616 617 618 619 620 621
      }
  });
  ```

## getAllFormsInfo

622 623
getAllFormsInfo(): Promise<Array<formInfo.FormInfo>>;

L
liweifeng 已提交
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639

获取设备上所有应用提供的卡片信息。

**系统能力:**

SystemCapability.Ability.Form

**返回值:**

| 类型          | 说明                                |
| :------------ | :---------------------------------- |
| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise实例,用于获取异步返回查询到的卡片信息 |

**示例:**

  ```js
L
liweifeng 已提交
640 641 642
  formHost.getAllFormsInfo().then((data) => {
      console.log('formHost getAllFormsInfo data:' + JSON.stringify(data));
  }).catch((error) => {
Y
yangzk 已提交
643
      console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error));
L
liweifeng 已提交
644 645 646 647 648
  });
  ```

## getFormsInfo

649 650
getFormsInfo(bundleName: string, callback: AsyncCallback<Array<formInfo.FormInfo>>): void;

L
liweifeng 已提交
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667

获取设备上指定应用程序提供的卡片信息。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

  | 参数名 | 类型    | 必填 | 说明    |
  | ------ | ------ | ---- | ------- |
  | bundleName | string | 是 |  要查询的应用程序包名称 |
  | callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | callback形式返回查询到的卡片信息 |

**示例:**

  ```js
Y
yangzk 已提交
668
  formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => {
L
liweifeng 已提交
669 670 671 672
      if (error.code) {
          console.log('formHost getFormsInfo, error:' + JSON.stringify(error));
      } else {
          console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
L
liweifeng 已提交
673 674 675 676 677 678
      }
  });
  ```

## getFormsInfo

679 680
getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback<Array<formInfo.FormInfo>>): void;

L
liweifeng 已提交
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698

获取设备上指定应用程序提供的卡片信息。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

  | 参数名 | 类型    | 必填 | 说明    |
  | ------ | ------ | ---- | ------- |
  | bundleName | string | 是 |  要查询的应用程序包名称 |
  | moduleName | string | 是 |  要查询的模块名称 |
  | callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | 是 | callback形式返回查询到的卡片信息 |

**示例:**

  ```js
Y
yangzk 已提交
699
  formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => {
L
liweifeng 已提交
700 701 702 703
      if (error.code) {
          console.log('formHost getFormsInfo, error:' + JSON.stringify(error));
      } else {
          console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
L
liweifeng 已提交
704 705 706 707 708 709
      }
  });
  ```

## getFormsInfo

710 711
getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<formInfo.FormInfo>>;

L
liweifeng 已提交
712

L
liweifeng 已提交
713
获取设备上指定应用程序提供的卡片信息。
L
liweifeng 已提交
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734

**系统能力:**

SystemCapability.Ability.Form

**参数:**

  | 参数名 | 类型    | 必填 | 说明    |
  | ------ | ------ | ---- | ------- |
  | bundleName | string | 是 |  要查询的应用程序包名称 |
  | moduleName | string | 否 |  要查询的模块名称 |

**返回值:**

| 类型          | 说明                                |
| :------------ | :---------------------------------- |
| Promise<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Promise实例,用于获取异步返回查询到的卡片信息 |

**示例:**

  ```js
L
liweifeng 已提交
735 736 737
  formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => {
      console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
  }).catch((error) => {
Y
yangzk 已提交
738
      console.log('formHost getFormsInfo, error:' + JSON.stringify(error));
L
liweifeng 已提交
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
  });
  ```

## deleteInvalidForms

deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<number>): void;

根据列表删除应用程序的无效卡片。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
754 755 756 757
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是   | 有效卡片标识列表 |
| callback | AsyncCallback<number> | 是 | callback形式返回删除的卡片个数 |
L
liweifeng 已提交
758 759 760 761 762 763

**示例:**

  ```js
  var formIds = new Array("12400633174999288", "12400633174999289");
  formHost.deleteInvalidForms(formIds, (error, data) => {
L
liweifeng 已提交
764 765 766 767
      if (error.code) {
          console.log('formHost deleteInvalidForms, error:' + JSON.stringify(error));
      } else {
          console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data));
L
liweifeng 已提交
768 769 770 771 772 773
      }
  });
  ```

## deleteInvalidForms

774
deleteInvalidForms(formIds: Array<string>): Promise<number>;
L
liweifeng 已提交
775 776 777

根据列表删除应用程序的无效卡片。

L
liweifeng 已提交
778 779 780 781
**系统能力:**

SystemCapability.Ability.Form

L
liweifeng 已提交
782 783
**参数:**

Y
yangzk 已提交
784 785 786
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是   | 有效卡片标识列表 |
L
liweifeng 已提交
787 788 789 790 791 792 793 794 795 796 797

**返回值:**

| 类型          | 说明                                |
| :------------ | :---------------------------------- |
| Promise<number> | Promise实例,用于获取异步返回删除的卡片个数 |

**示例:**

  ```js
  var formIds = new Array("12400633174999288", "12400633174999289");
L
liweifeng 已提交
798 799 800
  formHost.deleteInvalidForms(formIds).then((data) => {
      console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data));
  }).catch((error) => {
Y
yangzk 已提交
801
      console.log('formHost deleteInvalidForms, error:' + JSON.stringify(error));
L
liweifeng 已提交
802 803 804 805 806
  });
  ```

## acquireFormState

807
acquireFormState(want: Want, callback: AsyncCallback<formInfo.FormStateInfo>): void;
L
liweifeng 已提交
808 809 810 811 812 813 814 815 816

获取卡片状态

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Z
zengyawen 已提交
817 818
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
ahjxliubao2's avatar
ahjxliubao2 已提交
819
| want | [Want](js-apis-application-Want.md) | 是   | 查询卡片状态时携带的want信息 |
Z
zengyawen 已提交
820
| callback | AsyncCallback<[FormStateInfo](js-apis-formInfo.md#formstateinfo)> | 是 | callback形式返回卡片状态 |
L
liweifeng 已提交
821 822 823 824 825

**示例:**

  ```js
  var want = {
Y
yangzk 已提交
826 827 828 829 830 831 832 833
      "deviceId": "",
      "bundleName": "ohos.samples.FormApplication",
      "abilityName": "FormAbility",
      "parameters": {
          "ohos.extra.param.key.module_name": "entry",
          "ohos.extra.param.key.form_name": "widget",
          "ohos.extra.param.key.form_dimension": 2
      }
L
liweifeng 已提交
834 835
  };
  formHost.acquireFormState(want, (error, data) => {
L
liweifeng 已提交
836 837 838 839
      if (error.code) {
          console.log('formHost acquireFormState, error:' + JSON.stringify(error));
      } else {
          console.log('formHost acquireFormState, data:' + JSON.stringify(data));
L
liweifeng 已提交
840 841 842 843 844 845
      }
  });
  ```

## acquireFormState

846
acquireFormState(want: Want): Promise<formInfo.FormStateInfo>;
L
liweifeng 已提交
847

L
liweifeng 已提交
848
获取卡片状态。
L
liweifeng 已提交
849 850 851

**参数:**

Y
yangzk 已提交
852 853
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
ahjxliubao2's avatar
ahjxliubao2 已提交
854
| want   | [Want](js-apis-application-Want.md) | 是   | 查询卡片状态时携带的want信息 |
L
liweifeng 已提交
855 856 857 858 859

**返回值:**

| 类型          | 说明                                |
| :------------ | :---------------------------------- |
Z
zengyawen 已提交
860
| Promise<[FormStateInfo](js-apis-formInfo.md#formstateinfo)> | Promise实例,用于返回卡片状态 |
L
liweifeng 已提交
861 862 863 864 865 866 867 868 869

**系统能力:**

SystemCapability.Ability.Form

**示例:**

  ```js
  var want = {
Y
yangzk 已提交
870 871 872 873 874 875 876 877
      "deviceId": "",
      "bundleName": "ohos.samples.FormApplication",
      "abilityName": "FormAbility",
      "parameters": {
          "ohos.extra.param.key.module_name": "entry",
          "ohos.extra.param.key.form_name": "widget",
          "ohos.extra.param.key.form_dimension": 2
      }
L
liweifeng 已提交
878
  };
L
liweifeng 已提交
879 880 881
  formHost.acquireFormState(want).then((data) => {
      console.log('formHost acquireFormState, data:' + JSON.stringify(data));
  }).catch((error) => {
Y
yangzk 已提交
882
      console.log('formHost acquireFormState, error:' + JSON.stringify(error));
L
liweifeng 已提交
883 884 885 886 887 888 889
  });
  ```

## on("formUninstall")

on(type: "formUninstall", callback: Callback<string>): void;

L
liweifeng 已提交
890
订阅卡片卸载事件。
L
liweifeng 已提交
891 892 893 894 895 896 897

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
898 899 900 901
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| type | string | 是   | 填写"formUninstall",表示卡片卸载事件 |
| callback | Callback<string> | 是 | 需要注册的事件回调方法 |
L
liweifeng 已提交
902 903 904 905

**示例:**

  ```js
Y
yangzk 已提交
906 907 908 909
  let callback = function(formId) {
      console.log('formHost on formUninstall, formId:' + formId);
  }
  formHost.on("formUninstall", callback);
L
liweifeng 已提交
910 911 912 913
  ```

## off("formUninstall")

Y
yangzk 已提交
914
off(type: "formUninstall", callback?: Callback<string>): void;
L
liweifeng 已提交
915

L
liweifeng 已提交
916
取消订阅卡片卸载事件。
L
liweifeng 已提交
917 918 919 920 921 922 923

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
924 925 926 927
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| type | string | 是   | 填写"formUninstall",表示卡片卸载事件 |
| callback | Callback<string> | 否 | 需要注销的事件回调方法。缺省时,表示注销所有已注册事件回调 |
L
liweifeng 已提交
928 929 930 931

**示例:**

  ```js
Y
yangzk 已提交
932 933 934 935
  let callback = function(formId) {
      console.log('formHost on formUninstall, formId:' + formId);
  }
  formHost.off("formUninstall", callback);
L
liweifeng 已提交
936 937 938 939 940 941 942 943 944 945 946 947 948 949
  ```

## notifyFormsVisible

notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: AsyncCallback<void>): void;

通知卡片是否可见。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
950 951 952 953 954
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是   | 卡片标识列表 |
| isVisible | boolean | 是   | 是否可见 |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
955 956 957 958 959 960

**示例:**

  ```js
  var formIds = new Array("12400633174999288", "12400633174999289");
  formHost.notifyFormsVisible(formIds, true, (error, data) => {
L
liweifeng 已提交
961 962
      if (error.code) {
          console.log('formHost notifyFormsVisible, error:' + JSON.stringify(error));
L
liweifeng 已提交
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
      }
  });
  ```

## notifyFormsVisible

notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise<void>;

通知卡片是否可见。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

  | 参数名 | 类型    | 必填 | 说明    |
  | ------ | ------ | ---- | ------- |
  | formIds | Array<string> | 是   | 卡片标识列表 |
  | isVisible | boolean | 是   | 是否可见 |

L
liweifeng 已提交
984 985 986 987 988 989
**返回值:**

  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |

L
liweifeng 已提交
990 991 992 993
**示例:**

  ```js
  var formIds = new Array("12400633174999288", "12400633174999289");
L
liweifeng 已提交
994 995 996
  formHost.notifyFormsVisible(formIds, true).then(() => {
      console.log('formHost notifyFormsVisible success');
  }).catch((error) => {
Y
yangzk 已提交
997
      console.log('formHost notifyFormsVisible, error:' + JSON.stringify(error));
L
liweifeng 已提交
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
  });
  ```

## notifyFormsEnableUpdate

notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, callback: AsyncCallback<void>): void;

通知卡片是否启用更新状态。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

Y
yangzk 已提交
1013 1014 1015 1016 1017
| 参数名 | 类型    | 必填 | 说明    |
| ------ | ------ | ---- | ------- |
| formIds | Array<string> | 是   | 卡片标识列表 |
| isEnableUpdate | boolean | 是   | 是否使能更新 |
| callback | AsyncCallback<void> | 是 | callback形式返回结果 |
L
liweifeng 已提交
1018 1019 1020 1021 1022 1023

**示例:**

  ```js
  var formIds = new Array("12400633174999288", "12400633174999289");
  formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => {
L
liweifeng 已提交
1024 1025
      if (error.code) {
          console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error));
L
liweifeng 已提交
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
      }
  });
  ```

## notifyFormsEnableUpdate

notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): Promise<void>;

通知卡片是否启用更新状态。

**系统能力:**

SystemCapability.Ability.Form

**参数:**

  | 参数名 | 类型    | 必填 | 说明    |
  | ------ | ------ | ---- | ------- |
  | formIds | Array<string> | 是   | 卡片标识列表 |
  | isEnableUpdate | boolean | 是   | 是否使能更新 |

L
liweifeng 已提交
1047 1048 1049 1050 1051 1052
**返回值:**

  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<void> | 返回一个Promise,包含接口的结果 |

L
liweifeng 已提交
1053 1054 1055 1056
**示例:**

  ```js
  var formIds = new Array("12400633174999288", "12400633174999289");
L
liweifeng 已提交
1057 1058 1059
  formHost.notifyFormsEnableUpdate(formIds, true).then(() => {
      console.log('formHost notifyFormsEnableUpdate success');
  }).catch((error) => {
Y
yangzk 已提交
1060
      console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error));
L
liweifeng 已提交
1061 1062
  });
  ```