• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用call事件拉起指定UIAbility到后台
2
3
4许多应用希望借助卡片的能力,实现和应用在前台时相同的功能。例如音乐卡片,卡片上提供播放、暂停等按钮,点击不同按钮将触发音乐应用的不同功能,进而提高用户的体验。在卡片中使用**postCardAction**接口的call能力,能够将卡片提供方应用的指定的UIAbility拉到后台。同时,call能力提供了调用应用指定方法、传递数据的功能,使应用在后台运行时可以通过卡片上的按钮执行不同的功能。
5
6> **说明:**
7>
8> 本文主要介绍动态卡片的事件开发。对于静态卡片,请参见[FormLink](../reference/arkui-ts/ts-container-formlink.md)。
9
10## 约束限制
11
12-提供方应用需要具备后台运行权限([ohos.permission.KEEP_BACKGROUND_RUNNING](../security/permission-list.md#ohospermissionkeep_background_running))。
13
14## 开发步骤
15
16通常使用按钮控件来触发call事件,示例代码如下:
17
18
19- 在卡片页面中布局两个按钮,点击其中一个按钮时调用postCardAction向指定UIAbility发送call事件,并在事件内定义需要调用的方法和传递的数据。需要注意的是,method参数为必选参数,且类型需要为string类型,用于触发UIAbility中对应的方法。
20
21  ```ts
22  @Entry
23  @Component
24  struct WidgetCard {
25    build() {
26      Column() {
27        Button('功能A')
28          .onClick(() => {
29            console.info('call EntryAbility funA');
30            postCardAction(this, {
31              action: 'call',
32              abilityName: 'EntryAbility', // 只能跳转到当前应用下的UIAbility
33              params: {
34                method: 'funA' // 在EntryAbility中调用的方法名
35              }
36            });
37          })
38
39        Button('功能B')
40          .onClick(() => {
41            console.info('call EntryAbility funB');
42            postCardAction(this, {
43              action: 'call',
44              abilityName: 'EntryAbility', // 只能跳转到当前应用下的UIAbility
45              params: {
46                method: 'funB', // 在EntryAbility中调用的方法名
47                num: 1 // 需要传递的其他参数
48              }
49            });
50          })
51      }
52      .width('100%')
53      .height('100%')
54      .justifyContent(FlexAlign.SpaceAround)
55    }
56  }
57  ```
58
59- 在UIAbility中接收call事件并获取参数,根据传递的method不同,执行不同的方法。其余数据可以通过[readString](../reference/apis/js-apis-rpc.md#readstring)方法获取。需要注意的是,UIAbility需要onCreate生命周期中监听所需的方法。
60
61  ```ts
62  import UIAbility from '@ohos.app.ability.UIAbility';
63  import Base from '@ohos.base'
64  import rpc from '@ohos.rpc';
65  import Want from '@ohos.app.ability.Want';
66  import AbilityConstant from '@ohos.app.ability.AbilityConstant';
67
68
69  class MyParcelable implements rpc.Parcelable {
70    num: number;
71    str: string;
72    constructor(num: number, str: string) {
73      this.num = num;
74      this.str = str;
75    }
76    marshalling(messageSequence: rpc.MessageSequence): boolean {
77      messageSequence.writeInt(this.num);
78      messageSequence.writeString(this.str);
79      return true;
80    }
81    unmarshalling(messageSequence: rpc.MessageSequence): boolean {
82      this.num = messageSequence.readInt();
83      this.str = messageSequence.readString();
84      return true;
85    }
86  }
87
88  export default class CameraAbility extends UIAbility {
89    // 如果UIAbility第一次启动,在收到call事件后会触发onCreate生命周期回调
90    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
91      try {
92        // 监听call事件所需的方法
93        this.callee.on('funA', (data: rpc.MessageSequence) => {
94          // 获取call事件中传递的所有参数
95          console.info('FunACall param:' + JSON.stringify(data.readString()));
96          return new MyParcelable(1, 'aaa');
97        });
98        this.callee.on('funB', (data: rpc.MessageSequence) => {
99          // 获取call事件中传递的所有参数
100          console.info('FunBCall param:' + JSON.stringify(data.readString()));
101          return new MyParcelable(2, 'bbb');
102        });
103      } catch (err) {
104        console.error(`Failed to register callee on. Cause: ${JSON.stringify(err as Base.BusinessError)}`);
105      }
106    }
107
108    ...
109
110    // 进程退出时,解除监听
111    onDestroy() {
112      try {
113        this.callee.off('funA');
114        this.callee.off('funB');
115      } catch (err) {
116        console.error(`Failed to register callee off. Cause: ${JSON.stringify(err as Base.BusinessError)}`);
117      }
118    }
119  };
120  ```
121