卡片生命周期管理

创建ArkTS卡片,需实现FormExtensionAbility生命周期接口。

  1. 在EntryFormAbility.ets中,导入相关模块。

    import formInfo from '@ohos.app.form.formInfo';
    import formBindingData from '@ohos.app.form.formBindingData';
    import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
    import formProvider from '@ohos.app.form.formProvider';
    
  2. 在EntryFormAbility.ets中,实现FormExtensionAbility生命周期接口,其中在onAddForm的入参want中可以通过FormParam取出卡片的相关信息。

    import formInfo from '@ohos.app.form.formInfo';
    import formBindingData from '@ohos.app.form.formBindingData';
    import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
    import formProvider from '@ohos.app.form.formProvider';
    import { Configuration } from '@ohos.app.ability.Configuration';
    import Want from '@ohos.app.ability.Want';
    import Base from '@ohos.base';
    
    export default class EntryFormAbility extends FormExtensionAbility {
     onAddForm(want: Want) {
       console.info('[EntryFormAbility] onAddForm');
       // 使用方创建卡片时触发,提供方需要返回卡片数据绑定类
       let obj: Record<string, string> = {
         'title': 'titleOnAddForm',
         'detail': 'detailOnAddForm'
       };
       let formData = formBindingData.createFormBindingData(obj);
       return formData;
     }
    
     onCastToNormalForm(formId: string) {
       // 使用方将临时卡片转换为常态卡片触发,提供方需要做相应的处理
       console.info(`[EntryFormAbility] onCastToNormalForm, formId: ${formId}`);
     }
    
     onUpdateForm(formId: string) {
       // 若卡片支持定时更新/定点更新/卡片使用方主动请求更新功能,则提供方需要重写该方法以支持数据更新
       console.info('[EntryFormAbility] onUpdateForm');
       let obj: Record<string, string> = {
         'title': 'titleOnUpdateForm',
         'detail': 'detailOnUpdateForm'
       };
       let formData = formBindingData.createFormBindingData(obj);
       formProvider.updateForm(formId, formData).catch((err: Base.BusinessError) => {
         console.error(`[EntryFormAbility] Failed to updateForm. Code: ${err.code}, message: ${err.message}`);
       });
     }
    
     onChangeFormVisibility(newStatus: Record<string, number>) {
       // 需要配置formVisibleNotify为true,且为系统应用才会回调
       console.info('[EntryFormAbility] onChangeFormVisibility');
     }
    
     onFormEvent(formId: string, message: string) {
       // 若卡片支持触发事件,则需要重写该方法并实现对事件的触发
       console.info('[EntryFormAbility] onFormEvent');
     }
    
     onRemoveForm(formId: string) {
       // 当对应的卡片删除时触发的回调,入参是被删除的卡片ID
       console.info('[EntryFormAbility] onRemoveForm');
     }
    
     onConfigurationUpdate(config: Configuration) {
       // 当前formExtensionAbility存活时更新系统配置信息时触发的回调。
       // 需要注意,formExtensionAbility创建后5秒内无操作将会被清理。
       console.info('[EntryFormAbility] onConfigurationUpdate:' + JSON.stringify(config));
     }
    
     onAcquireFormState(want: Want) {
       // 卡片提供方接收查询卡片状态通知接口,默认返回卡片初始状态。
       return formInfo.FormState.READY;
     }
    }
    

说明:

FormExtensionAbility进程不能常驻后台,即在卡片生命周期回调函数中无法处理长时间的任务,在生命周期调度完成后会继续存在5秒,如5秒内没有新的生命周期回调触发则进程自动退出。针对可能需要5秒以上才能完成的业务逻辑,建议拉起主应用进行处理,处理完成后使用updateForm()通知卡片进行刷新。