• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# postCardAction
2
3postCardAction(component: Object, action: Object): void
4
5用于卡片内部和提供方应用间的交互,当前支持router、message和call三种类型的事件,仅在卡片中可以调用。
6
7> **说明:**
8>
9> 本接口从API version 9开始支持。
10
11**系统能力:** SystemCapability.ArkUI.ArkUI.Full
12
13**参数:**
14
15
16| **参数名** | **类型** | **必填** | **说明** |
17| -------- | -------- | -------- | -------- |
18| component | Object | 是 | 当前自定义组件的实例,通常传入this。 |
19| action | Object | 是 | action的具体描述,详情见下表。 |
20
21
22action参数说明:
23
24
25| **参数名** | **类型** |  **必填** | **取值说明** |
26| -------- | -------- | -------- | -------- |
27| action | string | 是 |action的类型,支持三种预定义的类型:<br/>-&nbsp;router:跳转到提供方应用的指定UIAbility。<br/>-&nbsp;message:自定义消息,触发后会调用提供方FormExtensionAbility的[onFormEvent()](../apis-form-kit/js-apis-app-form-formExtensionAbility.md#onformevent)生命周期回调。<br/>-&nbsp;call:后台启动提供方应用。触发后会拉起提供方应用的指定UIAbility(仅支持launchType为singleton的[UIAbility](../../application-models/uiability-launch-type.md),即启动模式为单实例的UIAbility),但不会调度到前台。提供方应用需要具备后台运行权限([ohos.permission.KEEP_BACKGROUND_RUNNING](../../security/AccessToken/permissions-for-all.md#ohospermissionkeep_background_running))。 |
28| bundleName | string | 否 | action为router&nbsp;/&nbsp;call&nbsp;类型时跳转的包名。 |
29| moduleName | string | 否 | action为router&nbsp;/&nbsp;call&nbsp;类型时跳转的模块名。 |
30| abilityName | string | 否 | action为router&nbsp;/&nbsp;call&nbsp;类型时跳转的UIAbility名。 |
31| uri<sup>11+</sup> | string   | 否   | action为router&nbsp;类型时跳转的UIAbility的统一资源标识符。uri和abilityName同时存在时,abilityName优先。 |
32| params | Object | 否 | 当前action携带的额外参数,内容使用JSON格式的键值对形式。 |
33
34>**说明:**
35>
36>"action"为"call"&nbsp;类型时,"params"需填入参数'method',且类型需为string类型,用于触发UIAbility中对应的方法。
37
38**示例:**
39
40```ts
41Button('跳转')
42  .width('40%')
43  .height('20%')
44  .onClick(() => {
45    postCardAction(this, {
46      action: 'router',
47      bundleName: 'com.example.myapplication',
48      abilityName: 'EntryAbility',
49      params: {
50        message: 'testForRouter' // 自定义要发送的message
51      }
52    });
53  })
54
55Button('拉至后台')
56  .width('40%')
57  .height('20%')
58  .onClick(() => {
59    postCardAction(this, {
60      action: 'call',
61      bundleName: 'com.example.myapplication',
62      abilityName: 'EntryAbility',
63      params: {
64        method: 'fun', // 自定义调用的方法名,必填
65        message: 'testForCall' // 自定义要发送的message
66      }
67    });
68  })
69
70Button('URI跳转')
71  .width('40%')
72  .height('20%')
73  .onClick(() => {
74    postCardAction(this, {
75      action: 'router',
76      uri: 'example://uri.ohos.com/link_page',
77      params: {
78        message: 'router msg for dynamic uri deeplink' // 自定义要发送的message
79      }
80    });
81  })
82
83```
84
85**待跳转应用 [module.json5](../../quick-start/module-configuration-file.md#skills标签) uris 配置示例:**
86
87```json
88"abilities": [
89  {
90    "skills": [
91      {
92        "uris": [
93          {
94            "scheme": "example",
95            "host": "uri.ohos.com",
96            "path": "link_page"
97          },
98        ]
99      }
100    ],
101  }
102]
103```
104