codecamp

卡片生命周期管理

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

  1. 在EntryFormAbility.ts中,导入相关模块。
    1. import formInfo from '@ohos.app.form.formInfo';
    2. import formBindingData from '@ohos.app.form.formBindingData';
    3. import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
    4. import formProvider from '@ohos.app.form.formProvider';
  2. 在EntryFormAbility.ts中,实现FormExtensionAbility生命周期接口,其中在onAddForm的入参want中可以通过FormParam取出卡片的相关信息。
    1. import formInfo from '@ohos.app.form.formInfo';
    2. import formBindingData from '@ohos.app.form.formBindingData';
    3. import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
    4. import formProvider from '@ohos.app.form.formProvider';
    5. export default class EntryFormAbility extends FormExtensionAbility {
    6. onAddForm(want) {
    7. console.info('[EntryFormAbility] onAddForm');
    8. // 在入参want中可以取出卡片的唯一标识:formId
    9. let formId: string = want.parameters[formInfo.FormParam.IDENTITY_KEY];
    10. // 使用方创建卡片时触发,提供方需要返回卡片数据绑定类
    11. let obj = {
    12. 'title': 'titleOnAddForm',
    13. 'detail': 'detailOnAddForm'
    14. };
    15. let formData = formBindingData.createFormBindingData(obj);
    16. return formData;
    17. }
    18. onCastToNormalForm(formId) {
    19. // Called when the form provider is notified that a temporary form is successfully
    20. // converted to a normal form.
    21. // 使用方将临时卡片转换为常态卡片触发,提供方需要做相应的处理
    22. console.info(`[EntryFormAbility] onCastToNormalForm, formId: ${formId}`);
    23. }
    24. onUpdateForm(formId) {
    25. // 若卡片支持定时更新/定点更新/卡片使用方主动请求更新功能,则提供方需要重写该方法以支持数据更新
    26. console.info('[EntryFormAbility] onUpdateForm');
    27. let obj = {
    28. 'title': 'titleOnUpdateForm',
    29. 'detail': 'detailOnUpdateForm'
    30. };
    31. let formData = formBindingData.createFormBindingData(obj);
    32. formProvider.updateForm(formId, formData).catch((err) => {
    33. if (err) {
    34. // 异常分支打印
    35. console.error(`[EntryFormAbility] Failed to updateForm. Code: ${err.code}, message: ${err.message}`);
    36. return;
    37. }
    38. });
    39. }
    40. onChangeFormVisibility(newStatus) {
    41. // Called when the form provider receives form events from the system.
    42. // 需要配置formVisibleNotify为true,且为系统应用才会回调
    43. console.info('[EntryFormAbility] onChangeFormVisibility');
    44. }
    45. onFormEvent(formId, message) {
    46. // Called when a specified message event defined by the form provider is triggered.
    47. // 若卡片支持触发事件,则需要重写该方法并实现对事件的触发
    48. console.info('[EntryFormAbility] onFormEvent');
    49. }
    50. onRemoveForm(formId) {
    51. // Called to notify the form provider that a specified form has been destroyed.
    52. // 当对应的卡片删除时触发的回调,入参是被删除的卡片ID
    53. console.info('[EntryFormAbility] onRemoveForm');
    54. }
    55. onConfigurationUpdate(config) {
    56. // 当系统配置信息置更新时触发的回调
    57. console.info('[EntryFormAbility] configurationUpdate:' + JSON.stringify(config));
    58. }
    59. onAcquireFormState(want) {
    60. // Called to return a {@link FormState} object.
    61. // 卡片提供方接收查询卡片状态通知接口,默认返回卡片初始状态。
    62. return formInfo.FormState.READY;
    63. }
    64. }
说明

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

配置卡片的配置文件
卡片页面能力说明
温馨提示
下载编程狮App,免费阅读超1000+编程语言教程
取消
确定
目录
HAR

关闭

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }