• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# FormLink
2
3提供静态卡片交互组件,用于静态卡片内部和提供方应用间的交互,当前支持router、message和call三种类型的事件。
4
5> **说明:**
6>
7> - 该组件从API Version 10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8>
9> - 该组件仅可以在静态卡片中使用。
10>
11> - 卡片具体开发指导请参考[卡片开发指南](../../../form/formkit-overview.md)。
12
13## 权限
14
1516
17## 子组件
18
19支持单个子组件
20
21## 接口
22
23FormLink(options: FormLinkOptions)
24
25**卡片能力:** 从API version 10开始,该接口支持在ArkTS卡片中使用。
26
27**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
28
29**系统能力:** SystemCapability.ArkUI.ArkUI.Full
30
31**参数:**
32
33| 参数名       | 类型                            | 必填   | 说明   |
34| --------- | ------------------------------- | ---- | ------ |
35| options | [FormLinkOptions](#formlinkoptions对象说明) | 是    | 定义卡片信息 |
36
37## FormLinkOptions对象说明
38
39**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
40
41**系统能力:** SystemCapability.ArkUI.ArkUI.Full
42
43| 名称      | 类型 | 必填 | 说明                                                     |
44| ----------- | -------- | ---- | ------------------------------------------------------------ |
45| action      | string   | 是   | action的类型,支持三种预定义的类型:<br/>-&nbsp;router:跳转到提供方应用的指定UIAbility。<br/>-&nbsp;message:自定义消息,触发后会调用提供方FormExtensionAbility的[onFormEvent()](../../apis-form-kit/js-apis-app-form-formExtensionAbility.md#formextensionabilityonformevent)生命周期回调。<br/>-&nbsp;call:后台启动提供方应用。触发后会拉起提供方应用的指定UIAbility(仅支持launchType为[singleton](../../../application-models/uiability-launch-type.md#singleton启动模式)的UIAbility,即启动模式为单实例的UIAbility),但不会调度到前台。提供方应用需要具备后台运行权限([ohos.permission.KEEP_BACKGROUND_RUNNING](../../../security/AccessToken/permissions-for-all.md#ohospermissionkeep_background_running))。 <br/>**说明:** <br/>不推荐使用router事件刷新卡片UI。<br/>**卡片能力:** 从API version 10开始,该接口支持在ArkTS卡片中使用。 |
46| moduleName  | string   | 否   | action为router&nbsp;/&nbsp;call&nbsp;类型时跳转的模块名。<br/>**卡片能力:** 从API version 10开始,该接口支持在ArkTS卡片中使用。 |
47| bundleName  | string   | 否   | action为router&nbsp;/&nbsp;call&nbsp;类型时跳转的包名。<br/>**卡片能力:** 从API version 10开始,该接口支持在ArkTS卡片中使用。 |
48| abilityName | string   | 否   | action为router&nbsp;/&nbsp;call&nbsp;类型时跳转的UIAbility名。<br/>**卡片能力:** 从API version 10开始,该接口支持在ArkTS卡片中使用。 |
49| uri<sup>11+</sup> | string   | 否   | action为router&nbsp;类型时跳转的UIAbility的统一资源标识符。uri和abilityName同时存在时,abilityName优先。<br/>**卡片能力:** 从API version 11开始,该接口支持在ArkTS卡片中使用。 |
50| params      | Object   | 否   | 当前action携带的额外参数,内容使用JSON格式的键值对形式。call&nbsp;类型时需填入参数'method',且类型需要为string类型,用于触发UIAbility中对应的方法。 <br/>**说明:** <br/>不推荐通过params传递卡片内部的状态变量。<br/>**卡片能力:** 从API version 10开始,该接口支持在ArkTS卡片中使用。 |
51
52## 属性
53
54支持[通用属性](ts-component-general-attributes.md)
55
56## 事件
57
58不支持[通用事件](ts-component-general-events.md)
59
60## 示例
61
62```ts
63@Entry
64@Component
65struct FormLinkDemo {
66  build() {
67    Column() {
68      Text("这是一个静态卡片").fontSize(20).margin(10)
69
70      // router事件用于静态卡片跳转到对应的UIAbility
71      FormLink({
72        action: "router",
73        abilityName: "EntryAbility",
74        params: {
75          'message': 'testForRouter' // 自定义要发送的message
76        }
77      }) {
78        Button("router event").width(120)
79      }.margin(10)
80
81
82      // message事件触发FormExtensionAbility的onFormEvent生命周期
83      FormLink({
84        action: "message",
85        abilityName: "EntryAbility",
86        params: {
87          'message': 'messageEvent' // 自定义要发送的message
88        }
89      }) {
90        Button("message event").width(120)
91      }.margin(10)
92
93
94      // call事件用于触发UIAbility中对应的方法
95      FormLink({
96        action: "call",
97        abilityName: "EntryAbility",
98        params: {
99          'method': 'funA', // 在EntryAbility中调用的方法名
100          'num': 1 // 需要传递的其他参数
101        }
102      }) {
103        Button("call event").width(120)
104      }.margin(10)
105
106      // router事件用于静态卡片deeplink跳转到对应的UIAbility
107      FormLink({
108        action: "router",
109        uri: 'example://uri.ohos.com/link_page',
110        params: {
111          message: 'router msg for static uri deeplink' // 自定义要发送的message
112        }
113      }) {
114        Button("deeplink event").width(120)
115      }.margin(10)
116    }
117    .justifyContent(FlexAlign.Center)
118    .width('100%').height('100%')
119  }
120}
121```
122
123![FormLink](figures/formLink.png)
124
125**待跳转应用 [module.json5](../../../quick-start/module-configuration-file.md#skills标签) uris 配置示例:**
126
127```json
128"abilities": [
129  {
130    "skills": [
131      {
132        "uris": [
133          {
134            "scheme": "example",
135            "host": "uri.ohos.com",
136            "path": "link_page"
137          },
138        ]
139      }
140    ],
141  }
142]
143```
144