卡片生命周期管理

2024-01-25 12:18 更新

創(chuàng)建ArkTS卡片,需實現(xiàn)FormExtensionAbility生命周期接口。

  1. 在EntryFormAbility.ts中,導(dǎo)入相關(guān)模塊。
    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中,實現(xiàn)FormExtensionAbility生命周期接口,其中在onAddForm的入?yún)ant中可以通過FormParam取出卡片的相關(guān)信息。
    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. // 在入?yún)ant中可以取出卡片的唯一標(biāo)識:formId
    9. let formId: string = want.parameters[formInfo.FormParam.IDENTITY_KEY];
    10. // 使用方創(chuàng)建卡片時觸發(fā),提供方需要返回卡片數(shù)據(jù)綁定類
    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. // 使用方將臨時卡片轉(zhuǎn)換為常態(tài)卡片觸發(fā),提供方需要做相應(yīng)的處理
    22. console.info(`[EntryFormAbility] onCastToNormalForm, formId: ${formId}`);
    23. }
    24. onUpdateForm(formId) {
    25. // 若卡片支持定時更新/定點更新/卡片使用方主動請求更新功能,則提供方需要重寫該方法以支持?jǐn)?shù)據(jù)更新
    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,且為系統(tǒng)應(yīng)用才會回調(diào)
    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. // 若卡片支持觸發(fā)事件,則需要重寫該方法并實現(xiàn)對事件的觸發(fā)
    48. console.info('[EntryFormAbility] onFormEvent');
    49. }
    50. onRemoveForm(formId) {
    51. // Called to notify the form provider that a specified form has been destroyed.
    52. // 當(dāng)對應(yīng)的卡片刪除時觸發(fā)的回調(diào),入?yún)⑹潜粍h除的卡片ID
    53. console.info('[EntryFormAbility] onRemoveForm');
    54. }
    55. onConfigurationUpdate(config) {
    56. // 當(dāng)系統(tǒng)配置信息置更新時觸發(fā)的回調(diào)
    57. console.info('[EntryFormAbility] configurationUpdate:' + JSON.stringify(config));
    58. }
    59. onAcquireFormState(want) {
    60. // Called to return a {@link FormState} object.
    61. // 卡片提供方接收查詢卡片狀態(tài)通知接口,默認(rèn)返回卡片初始狀態(tài)。
    62. return formInfo.FormState.READY;
    63. }
    64. }
說明

FormExtensionAbility進(jìn)程不能常駐后臺,即在卡片生命周期回調(diào)函數(shù)中無法處理長時間的任務(wù),在生命周期調(diào)度完成后會繼續(xù)存在5秒,如5秒內(nèi)沒有新的生命周期回調(diào)觸發(fā)則進(jìn)程自動退出。針對可能需要5秒以上才能完成的業(yè)務(wù)邏輯,建議拉起主應(yīng)用進(jìn)行處理,處理完成后使用updateForm通知卡片進(jìn)行刷新。

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號