harmony 鸿蒙使用call事件拉起指定UIAbility到后台

2023-06-24
浏览 (432)

使用call事件拉起指定UIAbility到后台

许多应用希望借助卡片的能力，实现和应用在前台时相同的功能。例如音乐卡片，卡片上提供播放、暂停等按钮，点击不同按钮将触发音乐应用的不同功能，进而提高用户的体验。在卡片中使用postCardAction接口的call能力，能够将卡片提供方应用的指定的UIAbility拉到后台。同时，call能力提供了调用应用指定方法、传递数据的功能，使应用在后台运行时可以通过卡片上的按钮执行不同的功能。

说明：

本文主要介绍动态卡片的事件开发。对于静态卡片，请参见FormLink。

通常使用按钮控件来触发call事件，示例代码如下：

在卡片页面中布局两个按钮，点击其中一个按钮时调用postCardAction向指定UIAbility发送call事件，并在事件内定义需要调用的方法和传递的数据。需要注意的是，method参数为必选参数，且类型需要为string类型，用于触发UIAbility中对应的方法。

  @Entry
  @Component
  struct WidgetCard {
    build() {
      Column() {
        Button('功能A')
          .margin('20%')
          .onClick(() => {
            console.info('call EntryAbility funA');
            postCardAction(this, {
              'action': 'call',
              'abilityName': 'EntryAbility', // 只能跳转到当前应用下的UIAbility
              'params': {
                'method': 'funA' // 在EntryAbility中调用的方法名
              }
            });
          })
  
        Button('功能B')
          .margin('20%')
          .onClick(() => {
            console.info('call EntryAbility funB');
            postCardAction(this, {
              'action': 'call',
              'abilityName': 'EntryAbility', // 只能跳转到当前应用下的UIAbility
              'params': {
                'method': 'funB', // 在EntryAbility中调用的方法名
                'num': 1 // 需要传递的其他参数
              }
            });
          })
      }
      .width('100%')
      .height('100%')
    }
  }

在UIAbility中接收call事件并获取参数，根据传递的method不同，执行不同的方法。其余数据可以通过readString方法获取。需要注意的是，UIAbility需要onCreate生命周期中监听所需的方法。

  import UIAbility from '@ohos.app.ability.UIAbility';
  import Base from '@ohos.base'
  import rpc from '@ohos.rpc';
  import Want from '@ohos.app.ability.Want';
  import AbilityConstant from '@ohos.app.ability.AbilityConstant';


  class MyParcelable implements rpc.Parcelable {
    num: number;
    str: string;
    constructor(num: number, str: string) {
      this.num = num;
      this.str = str;
    }
    marshalling(messageSequence: rpc.MessageSequence): boolean {
      messageSequence.writeInt(this.num);
      messageSequence.writeString(this.str);
      return true;
    }
    unmarshalling(messageSequence: rpc.MessageSequence): boolean {
      this.num = messageSequence.readInt();
      this.str = messageSequence.readString();
      return true;
    }
  }
  
  export default class CameraAbility extends UIAbility {
    // 如果UIAbility第一次启动，在收到call事件后会触发onCreate生命周期回调
    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
      try {
        // 监听call事件所需的方法
        this.callee.on('funA', (data: rpc.MessageSequence) => {
          // 获取call事件中传递的所有参数
          console.info('FunACall param:' + JSON.stringify(data.readString()));
          return new MyParcelable(1, 'aaa');
        });
        this.callee.on('funB', (data: rpc.MessageSequence) => {
          // 获取call事件中传递的所有参数
          console.info('FunACall param:' + JSON.stringify(data.readString()));
          return new MyParcelable(2, 'bbb');
        });
      } catch (err) {
        console.error(`Failed to register callee on. Cause: ${JSON.stringify(err as Base.BusinessError)}`);
      }
    }
  
    ...
  
    // 进程退出时，解除监听
    onDestroy() {
      try {
        this.callee.off('funA');
        this.callee.off('funB');
      } catch (err) {
        console.error(`Failed to register callee off. Cause: ${JSON.stringify(err as Base.BusinessError)}`);
      }
    }
  };