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