1# @ohos.app.ability.Want (Want) 2 3Want是对象间信息传递的载体，可以用于应用组件间的信息传递。Want的使用场景之一是作为startAbility的参数，其包含了指定的启动目标，以及启动时需携带的相关数据，例如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当UIAbilityA需要启动UIAbilityB并传入一些数据时，可使用Want作为载体将这些数据传递给UIAbilityB。 4 5> **说明：** 6> 7> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8 9## 导入模块 10 11```ts 12import { Want } from '@kit.AbilityKit'; 13``` 14 15## 属性 16 17**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 18 19**系统能力**：SystemCapability.Ability.AbilityBase 20 21| 名称 | 类型 | 必填 | 说明 | 22| ----------- | -------------------- | ---- | ------------------------------------------------------------ | 23| deviceId | string | 否 | 表示运行指定Ability的设备ID。如果未设置该字段，则表明指定本设备。 | 24| bundleName | string | 否 | 表示待启动Ability所在的应用Bundle名称。 | 25| moduleName | string | 否 | 表示待启动的Ability所属的模块名称。<br/>**说明：**<br/> 若待启动的Ability所属的模块为[HAR](../../quick-start/har-package.md)，则moduleName需为依赖该HAR的[HAP](../../quick-start/hap-package.md)/[HSP](../../quick-start/in-app-hsp.md)的moduleName。 | 26| abilityName | string | 否 | 表示待启动Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 | 27| action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。隐式Want定义及匹配规则请参见[显式Want与隐式Want匹配规则](../../application-models/explicit-implicit-want-mappings.md)。 | 28| entities | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器）。在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | 29| uri | string | 否 | 表示携带的数据，一般配合type使用，指明待处理的数据类型。如果在Want中指定了uri，则Want将匹配指定的Uri信息，包括`scheme`、`schemeSpecificPart`、`authority`和`path`信息。 | 30| type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如：'text/xml' 、 'image/*'等，MIME定义请参见https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | 31| parameters | Record\<string, Object> | 否 | 表示WantParams描述。<br />一、以下Key均由系统赋值，开发者手动修改也不会生效，系统在数据传递时会自动修改为实际值。<br />- ohos.aafwk.param.callerPid：表示拉起方的pid，值为字符串类型。<br />- ohos.aafwk.param.callerBundleName：表示拉起方的BundleName，值为字符串类型。<br />- ohos.aafwk.param.callerAbilityName：表示拉起方的AbilityName，值为字符串类型。<br />- ohos.aafwk.param.callerNativeName：表示native调用时拉起方的进程名，值为字符串类型。<br />- ohos.aafwk.param.callerAppId：表示拉起应用的AppId信息，值为字符串类型。<br />- ohos.aafwk.param.callerAppIdentifier：表示拉起应用的AppIdentifier信息，值为字符串类型。<br />- ohos.aafwk.param.callerToken：表示拉起方的token，值为字符串类型。<br />- ohos.aafwk.param.callerUid：表示[BundleInfo](js-apis-bundleManager-bundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid，值为数值类型。<br />- ohos.param.callerAppCloneIndex：表示拉起方应用的分身索引，值为数值类型。<br />- component.startup.newRules：表示是否启用新的管控规则，值为布尔类型。<br />- moduleName：表示拉起方的moduleName，值为字符串类型。<br />- ability.params.backToOtherMissionStack：表示是否支持跨任务链返回，值为布尔类型。<br />- ohos.ability.params.abilityRecoveryRestart：表示当前Ability是否发生了故障恢复重启，值为布尔类型。<br />- ohos.extra.param.key.contentTitle：表示原子化服务支持分享的标题，值为字符串类型。<br />- ohos.extra.param.key.shareAbstract：表示原子化服务支持分享的内容，值为字符串类型。<br />- ohos.extra.param.key.shareUrl：表示原子化服务支持分享的链接，值为字符串类型。<br />- ohos.extra.param.key.supportContinuePageStack：表示在跨端迁移过程中是否迁移页面栈信息，值为布尔类型，默认值为true，自动迁移页面栈信息。<br />- ohos.extra.param.key.supportContinueSourceExit：表示跨端迁移源端应用是否退出，值为布尔类型，默认值为true，源端应用自动退出。<br />- ohos.extra.param.key.showMode：表示拉起原子化服务的展示模式，值为枚举类型[wantConstant.ShowMode](js-apis-app-ability-wantConstant.md#showmode12)。<br />- ohos.dlp.params.sandbox：表示数据防泄漏（DLP）文件才会涉及。仅系统应用涉及。<br />- ohos.dlp.params.bundleName：表示数据防泄漏（DLP）的BundleName，值为字符串类型。仅系统应用涉及。<br />- ohos.dlp.params.moduleName：表示数据防泄漏（DLP）的moduleName，值为字符串类型。仅系统应用涉及。<br />- ohos.dlp.params.abilityName：表示数据防泄漏（DLP）的AbilityName，值为字符串类型。仅系统应用涉及。<br />- ohos.dlp.params.index：表示数据防泄漏（DLP）的索引，值为数值类型。仅系统应用涉及。<br />- ohos.ability.params.asssertFaultSessionId：表示AssertFault的会话ID，值为字符串类型。仅系统应用涉及。<br /><br />二、以下是由系统定义、开发者按需赋值的Key。<br />- ability.params.stream：指示携带的文件URI要授权给目标方，值为string类型的文件URI数组。<br />- ohos.extra.param.key.appCloneIndex：指示分身应用索引。<br />- ohos.params.appLaunchTrustList：指示隐式启动时的应用过滤列表，隐式启动时仅匹配列表中的应用，值为string类型的[AppIdentifier](js-apis-bundleManager-bundleInfo.md#signatureinfo)数组，过滤列表最多支持50个应用，传入空数组不生效。**说明**：该参数从API version 17开始支持。<br /><br />三、除了上述两种情况，应用间还可以相互约定传入的键值对。<br /><br />**说明**：<br/>want的Params操作的常量的具体信息请参考[wantConstant](js-apis-app-ability-wantConstant.md)。<br/>需注意，WantParams支持传输的最大数据量为200KB。当数据量超过200KB时，请使用[WriteRawDataBuffer](../apis-ipc-kit/js-apis-rpc.md#writerawdatabuffer11)或[uri](../apis-arkts/js-apis-uri.md)的方式进行数据传输。<br/>parameters的Value值仅支持基本数据类型：String、Number、Boolean、Object、undefined和null，不支持传递Object内部的function。 | 32| [flags](js-apis-app-ability-wantConstant.md#flags) | number | 否 | 表示处理Want的方式。默认传数字。<br />例如通过wantConstant.Flags.FLAG_ABILITY_CONTINUATION表示是否以设备间迁移方式启动Ability。 | 33| fds<sup>15+</sup> | Record\<string, number> | 否 | 表示Want文件描述符，用于标识被打开的Want文件，可通过[fs.open](../apis-core-file-kit/js-apis-file-fs.md#fsopen)获取。当业务不再使用该文件描述符时，需要使用[fs.close](../apis-core-file-kit/js-apis-file-fs.md#fsclose)及时销毁，防止fd泄露。<br>**原子化服务API**：从API version 15开始，该接口支持在原子化服务中使用。 | 34 35**示例：** 36 37- 基础用法：在UIAbility对象中调用，示例中的context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。 38 39 ```ts 40 import { UIAbility, Want } from '@kit.AbilityKit'; 41 import { window } from '@kit.ArkUI'; 42 import { BusinessError } from '@kit.BasicServicesKit'; 43 44 export default class EntryAbility extends UIAbility { 45 onWindowStageCreate(windowStage: window.WindowStage): void { 46 let want: Want = { 47 deviceId: '', // deviceId为空表示本设备 48 bundleName: 'com.example.myapplication', 49 abilityName: 'FuncAbility', 50 moduleName: 'entry' // moduleName非必选 51 }; 52 53 this.context.startAbility(want, (err: BusinessError) => { 54 if (err.code) { 55 // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability 56 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 57 } 58 }); 59 } 60 } 61 ``` 62 63- 目前支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等。 64 65 * 字符串（String） 66 ```ts 67 import { UIAbility, Want } from '@kit.AbilityKit'; 68 import { window } from '@kit.ArkUI'; 69 import { BusinessError } from '@kit.BasicServicesKit'; 70 71 export default class EntryAbility extends UIAbility { 72 onWindowStageCreate(windowStage: window.WindowStage): void { 73 let want: Want = { 74 bundleName: 'com.example.myapplication', 75 abilityName: 'FuncAbility', 76 parameters: { 77 keyForString: 'str', 78 }, 79 }; 80 81 this.context.startAbility(want, (err: BusinessError) => { 82 if (err.code) { 83 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 84 } 85 }); 86 } 87 } 88 ``` 89 * 数字（Number） 90 ```ts 91 import { UIAbility, Want } from '@kit.AbilityKit'; 92 import { window } from '@kit.ArkUI'; 93 import { BusinessError } from '@kit.BasicServicesKit'; 94 95 export default class EntryAbility extends UIAbility { 96 onWindowStageCreate(windowStage: window.WindowStage): void { 97 let want: Want = { 98 bundleName: 'com.example.myapplication', 99 abilityName: 'FuncAbility', 100 parameters: { 101 keyForInt: 100, 102 keyForDouble: 99.99, 103 }, 104 }; 105 106 this.context.startAbility(want, (err: BusinessError) => { 107 if (err.code) { 108 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 109 } 110 }); 111 } 112 } 113 ``` 114 * 布尔（Boolean） 115 ```ts 116 import { UIAbility, Want } from '@kit.AbilityKit'; 117 import { window } from '@kit.ArkUI'; 118 import { BusinessError } from '@kit.BasicServicesKit'; 119 120 export default class EntryAbility extends UIAbility { 121 onWindowStageCreate(windowStage: window.WindowStage): void { 122 let want: Want = { 123 bundleName: 'com.example.myapplication', 124 abilityName: 'FuncAbility', 125 parameters: { 126 keyForBool: true, 127 }, 128 }; 129 130 this.context.startAbility(want, (err: BusinessError) => { 131 if (err.code) { 132 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 133 } 134 }); 135 } 136 } 137 ``` 138 * 对象（Object） 139 ```ts 140 import { UIAbility, Want } from '@kit.AbilityKit'; 141 import { window } from '@kit.ArkUI'; 142 import { BusinessError } from '@kit.BasicServicesKit'; 143 144 export default class EntryAbility extends UIAbility { 145 onWindowStageCreate(windowStage: window.WindowStage): void { 146 let want: Want = { 147 bundleName: 'com.example.myapplication', 148 abilityName: 'FuncAbility', 149 parameters: { 150 keyForObject: { 151 keyForObjectString: 'str', 152 keyForObjectInt: -200, 153 keyForObjectDouble: 35.5, 154 keyForObjectBool: false, 155 }, 156 }, 157 }; 158 159 this.context.startAbility(want, (err: BusinessError) => { 160 if (err.code) { 161 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 162 } 163 }); 164 } 165 } 166 ``` 167 * 数组（Array） 168 169 ```ts 170 import { UIAbility, Want } from '@kit.AbilityKit'; 171 import { window } from '@kit.ArkUI'; 172 import { BusinessError } from '@kit.BasicServicesKit'; 173 174 export default class EntryAbility extends UIAbility { 175 onWindowStageCreate(windowStage: window.WindowStage): void { 176 let want: Want = { 177 bundleName: 'com.example.myapplication', 178 abilityName: 'FuncAbility', 179 parameters: { 180 keyForArrayString: ['str1', 'str2', 'str3'], 181 keyForArrayInt: [100, 200, 300, 400], 182 keyForArrayDouble: [0.1, 0.2], 183 keyForArrayObject: [{ obj1: 'aaa' }, { obj2: 100 }], 184 }, 185 }; 186 187 this.context.startAbility(want, (err: BusinessError) => { 188 if (err.code) { 189 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 190 } 191 }); 192 } 193 } 194 ``` 195 196 * 文件描述符（FD） 197 198 ```ts 199 import { UIAbility, Want } from '@kit.AbilityKit'; 200 import { window } from '@kit.ArkUI'; 201 import { BusinessError } from '@kit.BasicServicesKit'; 202 import { fileIo } from '@kit.CoreFileKit'; 203 204 export default class EntryAbility extends UIAbility { 205 onWindowStageCreate(windowStage: window.WindowStage): void { 206 let fd: number = 0; 207 208 try { 209 fd = fileIo.openSync('/data/storage/el2/base/haps/pic.png').fd; 210 } catch(err) { 211 let code = (err as BusinessError).code; 212 let message = (err as BusinessError).message; 213 console.error(`Failed to openSync. Code: ${code}, message: ${message}`); 214 } 215 let want: Want = { 216 deviceId: '', // deviceId为空表示本设备 217 bundleName: 'com.example.myapplication', 218 abilityName: 'FuncAbility', 219 moduleName: 'entry', // moduleName非必选 220 parameters: { 221 'keyFd': { 'type': 'FD', 'value': fd } // {'type':'FD', 'value':fd}是固定用法，用于表示该数据是FD 222 } 223 }; 224 225 this.context.startAbility(want, (err: BusinessError) => { 226 if (err.code) { 227 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 228 } 229 }); 230 } 231 } 232 ``` 233 234 * parameters参数用法：parameters携带开发者自定义参数，由UIAbilityA传递给UIAbilityB，并在UIAbilityB中进行获取。 235 236 ```ts 237 // (1) UIAbilityA通过startability启动UIAbilityB 238 import { UIAbility, Want } from '@kit.AbilityKit'; 239 import { window } from '@kit.ArkUI'; 240 import { BusinessError } from '@kit.BasicServicesKit'; 241 242 export default class EntryAbility extends UIAbility { 243 onWindowStageCreate(windowStage: window.WindowStage): void { 244 let want: Want = { 245 bundleName: 'com.example.myapplication', 246 abilityName: 'UIAbilityB', 247 parameters: { 248 developerParameters: 'parameters', 249 }, 250 }; 251 252 this.context.startAbility(want, (err: BusinessError) => { 253 if (err.code) { 254 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 255 } 256 }); 257 } 258 } 259 ``` 260 261 ```ts 262 // (2) 以UIAbilityB实例首次启动为例，会进入到UIAbilityB的onCreate生命周期 263 import { UIAbility, Want, AbilityConstant } from '@kit.AbilityKit'; 264 265 class UIAbilityB extends UIAbility { 266 onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) { 267 console.log(`onCreate, want parameters: ${want.parameters?.developerParameters}`); 268 } 269 } 270 ``` 271 * parameters参数中[wantConstant](js-apis-app-ability-wantConstant.md)的Key的使用方法。 272 273 ```ts 274 import { UIAbility, Want, wantConstant } from '@kit.AbilityKit'; 275 import { window } from '@kit.ArkUI'; 276 import { BusinessError } from '@kit.BasicServicesKit'; 277 278 export default class EntryAbility extends UIAbility { 279 onWindowStageCreate(windowStage: window.WindowStage): void { 280 let want: Want = { 281 bundleName: 'com.example.myapplication', 282 abilityName: 'FuncAbility', 283 parameters: { 284 [wantConstant.Params.CONTENT_TITLE_KEY]: 'contentTitle', 285 }, 286 }; 287 288 this.context.startAbility(want, (err: BusinessError) => { 289 if (err.code) { 290 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 291 } 292 }); 293 } 294 } 295 ``` 296 * parameters参数中获取拉起方的信息。 297 298 详见[获取UIAbility拉起方的信息](../../application-models/uiability-usage.md#获取uiability拉起方的信息)。 299
