• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 卡片事件能力说明
2
3针对动态卡片，ArkTS卡片中提供了postCardAction()接口用于卡片内部和提供方应用间的交互，当前支持router、message和call三种类型的事件，仅在卡片中可以调用。
4<br/>针对静态卡片，ArkTS卡片提供了[FormLink](../reference/arkui-ts/ts-container-formlink.md)用于卡片内部和提供方应用间的交互。
5
6## 动态卡片事件能力说明
7![WidgetPostCardAction](figures/WidgetPostCardAction.png)
8<br/>接口定义：postCardAction(component: Object, action: Object): void
9
10
11接口参数说明：
12
13
14| **参数名** | **参数类型** | **必填** | **参数描述** |
15| -------- | -------- | -------- | -------- |
16| component | Object | 是 | 当前自定义组件的实例，通常传入this。 |
17| action | Object | 是 | action的具体描述，详情见下表。 |
18
19
20action参数说明：
21
22
23| **Key** | **Value** | **样例描述** |
24| -------- | -------- | -------- |
25| "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（仅支持launchType为singleton的[UIAbility](uiability-launch-type.md)，即启动模式为单实例的UIAbility），但不会调度到前台。提供方应用需要具备后台运行权限([ohos.permission.KEEP_BACKGROUND_RUNNING](../security/permission-list.md#ohospermissionkeep_background_running))。 |
26| "bundleName" | string | "action"为"router"&nbsp;/&nbsp;"call"&nbsp;类型时跳转的包名，可选。 |
27| "moduleName" | string | "action"为"router"&nbsp;/&nbsp;"call"&nbsp;类型时跳转的模块名，可选。 |
28| "abilityName" | string | "action"为"router"&nbsp;/&nbsp;"call"&nbsp;类型时跳转的UIAbility名，必填。 |
29| "params" | Object | 当前action携带的额外参数，内容使用JSON格式的键值对形式。必填。 |
30
31>![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
32>
33>"action"为"call"&nbsp;类型时，"params"需填入参数'method'，且类型需为string类型，用于触发UIAbility中对应的方法。
34
35`postCardAction()`接口示例代码：
36
37```ts
38Button('跳转')
39  .width('40%')
40  .height('20%')
41  .onClick(() => {
42    postCardAction(this, {
43      action: 'router',
44      bundleName: 'com.example.myapplication',
45      abilityName: 'EntryAbility',
46      params: {
47        message: 'testForRouter' // 自定义要发送的message
48      }
49    });
50  })
51
52Button('拉至后台')
53  .width('40%')
54  .height('20%')
55  .onClick(() => {
56    postCardAction(this, {
57      action: 'call',
58      bundleName: 'com.example.myapplication',
59      abilityName: 'EntryAbility',
60      params: {
61        method: 'fun', // 自定义调用的方法名，必填
62        message: 'testForCall' // 自定义要发送的message
63      }
64    });
65  })
66```
67
68## 静态卡片事件能力说明
69请参见[FormLink](../reference/arkui-ts/ts-container-formlink.md)
70