arkts-ui-widget-event-overview.md 2.7 KB
Newer Older
Z
zhongjianfei 已提交
1 2
# 卡片事件能力说明

3
ArkTS卡片中提供了postCardAction()接口用于卡片内部和提供方应用间的交互,当前支持router、message和call三种类型的事件,仅在卡片中可以调用。  
Z
zhongjianfei 已提交
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
![WidgetPostCardAction](figures/WidgetPostCardAction.png)


接口定义:postCardAction(component: Object, action: Object): void


接口参数说明:


| **参数名** | **参数类型** | **必填** | **参数描述** |
| -------- | -------- | -------- | -------- |
| component | Object | 是 | 当前自定义组件的实例,通常传入this。 |
| action | Object | 是 | action的具体描述,详情见下表。 |


action参数说明:


| **Key** | **Value** | **样例描述** |
| -------- | -------- | -------- |
W
wangkailong 已提交
24
| "action" | string | action的类型,支持三种预定义的类型:<br/>-&nbsp;"router":跳转到提供方应用的指定UIAbility。<br/>-&nbsp;"message":自定义消息,触发后会调用提供方FormExtensionAbility的[onFormEvent()](../reference/apis/js-apis-app-form-formExtensionAbility.md#onformevent)生命周期回调。<br/>-&nbsp;"call":后台启动提供方应用。触发后会拉起提供方应用的指定UIAbility,但不会调度到前台。提供方应用需要具备后台运行权限([ohos.permission.KEEP_BACKGROUND_RUNNING](../security/permission-list.md#ohospermissionkeep_background_running))。 |
Z
zhongjianfei 已提交
25 26 27
| "bundleName" | string | "router"&nbsp;/&nbsp;"call"&nbsp;类型时跳转的包名,可选。 |
| "moduleName" | string | "router"&nbsp;/&nbsp;"call"&nbsp;类型时跳转的模块名,可选。 |
| "abilityName" | string | "router"&nbsp;/&nbsp;"call"&nbsp;类型时跳转的UIAbility名,必填。 |
W
wangkailong 已提交
28
| "params" | Object | 当前action携带的额外参数,内容使用JSON格式的键值对形式。"call"&nbsp;类型时需填入参数'method',且类型需要为string类型,用于触发UIAbility中对应的方法,必填。 |
Z
zhongjianfei 已提交
29 30


31
`postCardAction()`接口示例代码:
Z
zhongjianfei 已提交
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

```typescript
Button('跳转')
  .width('40%')
  .height('20%')
  .onClick(() => {
    postCardAction(this, {
      'action': 'router',
      'bundleName': 'com.example.myapplication',
      'abilityName': 'EntryAbility',
      'params': {
        'message': 'testForRouter' // 自定义要发送的message
      }
    });
  })
47

W
wangkailong 已提交
48 49 50 51 52 53 54 55 56 57
Button('拉至后台')
  .width('40%')
  .height('20%')
  .onClick(() => {
    postCardAction(this, {
      'action': 'call',
      'bundleName': 'com.example.myapplication',
      'abilityName': 'EntryAbility',
      'params': {
        'method': 'fun', // 自定义调用的方法名,必填
Z
zhongjianfei 已提交
58
        'message': 'testForCall' // 自定义要发送的message
W
wangkailong 已提交
59 60 61 62
      }
    });
  })
```
Z
zhongjianfei 已提交
63 64


W
wangkailong 已提交
65
以下介绍通过卡片事件实现的典型开发场景。