卡片事件能力说明
卡片事件能力说明
ArkTS卡片中提供了postCardAction()接口用于卡片内部和提供方应用间的交互,当前支持router、message和call三种类型的事件,仅在卡片中可以调用。
接口定义:postCardAction(component: Object, action: Object): void
接口参数说明:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
component | Object | 是 | 当前自定义组件的实例,通常传入this。 |
action | Object | 是 | action的具体描述,详情见下表。 |
action参数说明:
Key | Value | 样例描述 |
---|---|---|
"action" | string | action的类型,支持三种预定义的类型: - "router":应用跳转,触发后会跳转到对应UIAbility,仅允许跳转到当前应用的UIAbility。 - "message":自定义消息,触发后会调用提供方FormExtensionAbility的onFormEvent()生命周期回调。 - "call":应用非前台启动,触发后会启动对应的UIAbility,但不会调度到前台,call的目标应用需要具备后台运行权限(ohos.permission.KEEP_BACKGROUND_RUNNING)。 |
"bundleName" | string | "router" / "call" 类型时跳转的包名,可选。 |
"moduleName" | string | "router" / "call" 类型时跳转的模块名,可选。 |
"abilityName" | string | "router" / "call" 类型时跳转的UIAbility名,必填。 |
"params" | Object | 当前action携带的额外参数,内容使用JSON格式的键值对形式。 |
postCardAction()接口示例代码:
Button('跳转')
.width('40%')
.height('20%')
.onClick(() => {
postCardAction(this, {
'action': 'router',
'bundleName': 'com.example.myapplication',
'abilityName': 'EntryAbility',
'params': {
'message': 'testForRouter' // 自定义要发送的message
}
});
})
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
以下是卡片开发过程中可以通过卡片事件实现的典型开发场景: