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