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