• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 卡片生命周期管理
2
3
4创建ArkTS卡片，需实现[FormExtensionAbility](../reference/apis-form-kit/js-apis-app-form-formExtensionAbility.md)生命周期接口。
5
61. 在EntryFormAbility.ets中，导入相关模块。
7    ```ts
8    import { formBindingData, FormExtensionAbility, formInfo, formProvider } from '@kit.FormKit';
9    import { Configuration, Want } from '@kit.AbilityKit';
10    import { BusinessError } from '@kit.BasicServicesKit';
11    import { hilog } from '@kit.PerformanceAnalysisKit';
12    ```
13
142. 在EntryFormAbility.ets中，实现[FormExtensionAbility](../reference/apis-form-kit/js-apis-app-form-formExtensionAbility.md)生命周期接口，其中在onAddForm的入参[want](../reference/apis-ability-kit/js-apis-app-ability-want.md)中可以通过[FormParam](../reference/apis-form-kit/js-apis-app-form-formInfo.md#formparam)取出卡片的相关信息。
15      ```ts
16      const TAG: string = 'EntryFormAbility';
17      const DOMAIN_NUMBER: number = 0xFF00;
18
19      export default class EntryFormAbility extends FormExtensionAbility {
20        onAddForm(want: Want): formBindingData.FormBindingData {
21          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onAddForm');
22          hilog.info(DOMAIN_NUMBER, TAG, want.parameters?.[formInfo.FormParam.NAME_KEY] as string);
23
24          // ...
25          // 卡片使用方创建卡片时触发，提供方需要返回卡片数据绑定类
26          let obj: Record<string, string> = {
27            'title': 'titleOnAddForm',
28            'detail': 'detailOnAddForm'
29          };
30          let formData: formBindingData.FormBindingData = formBindingData.createFormBindingData(obj);
31          return formData;
32        }
33
34        onCastToNormalForm(formId: string): void {
35          // 卡片使用方将临时卡片转换为常态卡片触发，提供方需要做相应的处理。
36          // 1、临时卡、常态卡是卡片使用方的概念。
37          // 2、临时卡是短期存在的，在特定事件或用户行为后显示，完成后自动消失。
38          // 3、常态卡是持久存在的，在用户未进行清除或更改的情况下，会一直存在，平时开发的功能卡片属于常态卡。
39          // 4、目前手机上没有地方会使用临时卡。
40          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onCastToNormalForm');
41        }
42
43        onUpdateForm(formId: string): void {
44          // 若卡片支持定时更新/定点更新/卡片使用方主动请求更新功能，则提供方需要重写该方法以支持数据更新
45          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onUpdateForm');
46          let obj: Record<string, string> = {
47            'title': 'titleOnUpdateForm',
48            'detail': 'detailOnUpdateForm'
49          };
50          let formData: formBindingData.FormBindingData = formBindingData.createFormBindingData(obj);
51          formProvider.updateForm(formId, formData).catch((error: BusinessError) => {
52            hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] updateForm, error:' + JSON.stringify(error));
53          });
54        }
55
56        onChangeFormVisibility(newStatus: Record<string, number>): void {
57          // 卡片使用方发起可见或者不可见通知触发，提供方需要做相应的处理，仅系统应用生效
58          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onChangeFormVisibility');
59        }
60
61        onFormEvent(formId: string, message: string): void {
62          // 若卡片支持触发事件，则需要重写该方法并实现对事件的触发
63          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onFormEvent');
64          // ...
65        }
66
67        onRemoveForm(formId: string): void {
68          // 删除卡片实例数据
69          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onRemoveForm');
70          // 删除之前持久化的卡片实例数据
71          // 此接口请根据实际情况实现，具体请参考：FormExtAbility Stage模型卡片实例
72        }
73
74        onConfigurationUpdate(config: Configuration) {
75          // 当前formExtensionAbility存活时更新系统配置信息时触发的回调。
76          // 需注意：formExtensionAbility创建后10秒内无操作将会被清理。
77          hilog.info(DOMAIN_NUMBER, TAG, '[EntryFormAbility] onConfigurationUpdate:' + JSON.stringify(config));
78        }
79
80        onAcquireFormState(want: Want) {
81          // 卡片提供方接收查询卡片状态通知接口，默认返回卡片初始状态。
82          return formInfo.FormState.READY;
83        }
84      }
85      ```
86
87> **说明：**
88>
89> FormExtensionAbility进程不能常驻后台，即在卡片生命周期回调函数中无法处理长时间的任务，在生命周期调度完成后会继续存在10秒，如10秒内没有新的生命周期回调触发则进程自动退出。针对可能需要10秒以上才能完成的业务逻辑，建议[拉起主应用](arkts-ui-widget-event-uiability.md)进行处理，处理完成后使用[updateForm](../reference/apis-form-kit/js-apis-app-form-formProvider.md#updateform)通知卡片进行刷新。
90