• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 卡片生命周期管理
2
3
4创建ArkTS卡片，需实现[FormExtensionAbility](../reference/apis/js-apis-app-form-formExtensionAbility.md)生命周期接口。
5
6
71. 在EntryFormAbility.ets中，导入相关模块。
8
9   ```ts
10   import formInfo from '@ohos.app.form.formInfo';
11   import formBindingData from '@ohos.app.form.formBindingData';
12   import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
13   import formProvider from '@ohos.app.form.formProvider';
14   ```
15
162. 在EntryFormAbility.ets中，实现[FormExtensionAbility](../reference/apis/js-apis-app-form-formExtensionAbility.md)生命周期接口，其中在onAddForm的入参want中可以通过[FormParam](../reference/apis/js-apis-app-form-formInfo.md#formparam)取出卡片的相关信息。
17
18   ```typescript
19   import formInfo from '@ohos.app.form.formInfo';
20   import formBindingData from '@ohos.app.form.formBindingData';
21   import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
22   import formProvider from '@ohos.app.form.formProvider';
23   import { Configuration } from '@ohos.app.ability.Configuration';
24   import Want from '@ohos.app.ability.Want';
25   import Base from '@ohos.base';
26
27   export default class EntryFormAbility extends FormExtensionAbility {
28    onAddForm(want: Want) {
29      console.info('[EntryFormAbility] onAddForm');
30      // 使用方创建卡片时触发，提供方需要返回卡片数据绑定类
31      let obj: Record<string, string> = {
32        'title': 'titleOnAddForm',
33        'detail': 'detailOnAddForm'
34      };
35      let formData = formBindingData.createFormBindingData(obj);
36      return formData;
37    }
38
39    onCastToNormalForm(formId: string) {
40      // Called when the form provider is notified that a temporary form is successfully
41      // converted to a normal form.
42      // 使用方将临时卡片转换为常态卡片触发，提供方需要做相应的处理
43      console.info(`[EntryFormAbility] onCastToNormalForm, formId: ${formId}`);
44    }
45
46    onUpdateForm(formId: string) {
47      // 若卡片支持定时更新/定点更新/卡片使用方主动请求更新功能，则提供方需要重写该方法以支持数据更新
48      console.info('[EntryFormAbility] onUpdateForm');
49      let obj: Record<string, string> = {
50        'title': 'titleOnUpdateForm',
51        'detail': 'detailOnUpdateForm'
52      };
53      let formData = formBindingData.createFormBindingData(obj);
54      formProvider.updateForm(formId, formData).catch((err: Base.BusinessError) => {
55        console.error(`[EntryFormAbility] Failed to updateForm. Code: ${err.code}, message: ${err.message}`);
56      });
57    }
58
59    onChangeFormVisibility(newStatus: Record<string, number>) {
60      // Called when the form provider receives form events from the system.
61      // 需要配置formVisibleNotify为true，且为系统应用才会回调
62      console.info('[EntryFormAbility] onChangeFormVisibility');
63    }
64
65    onFormEvent(formId: string, message: string) {
66      // Called when a specified message event defined by the form provider is triggered.
67      // 若卡片支持触发事件，则需要重写该方法并实现对事件的触发
68      console.info('[EntryFormAbility] onFormEvent');
69    }
70
71    onRemoveForm(formId: string) {
72      // Called to notify the form provider that a specified form has been destroyed.
73      // 当对应的卡片删除时触发的回调，入参是被删除的卡片ID
74      console.info('[EntryFormAbility] onRemoveForm');
75    }
76
77    onConfigurationUpdate(config: Configuration) {
78      // 当系统配置信息更新时触发的回调
79      console.info('[EntryFormAbility] onConfigurationUpdate:' + JSON.stringify(config));
80    }
81
82    onAcquireFormState(want: Want) {
83      // Called to return a {@link FormState} object.
84      // 卡片提供方接收查询卡片状态通知接口，默认返回卡片初始状态。
85      return formInfo.FormState.READY;
86    }
87   }
88   ```
89
90
91> **说明：**
92>
93> FormExtensionAbility进程不能常驻后台，即在卡片生命周期回调函数中无法处理长时间的任务，在生命周期调度完成后会继续存在5秒，如5秒内没有新的生命周期回调触发则进程自动退出。针对可能需要5秒以上才能完成的业务逻辑，建议[拉起主应用](arkts-ui-widget-event-uiability.md)进行处理，处理完成后使用[`updateForm()`](../reference/apis/js-apis-app-form-formProvider.md#updateform)通知卡片进行刷新。
94