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所属的模块名称。 | 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 /><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-ability-wantConstant.md#flags) | number | 否 | 表示处理Want的方式。默认传数字。<br />例如通过wantConstant.Flags.FLAG_ABILITY_CONTINUATION表示是否以设备间迁移方式启动Ability。 | 33 34**示例：** 35 36- 基础用法：在UIAbility对象中调用，示例中的context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。 37 38 ```ts 39 import { common, Want } from '@kit.AbilityKit'; 40 import { BusinessError } from '@kit.BasicServicesKit'; 41 42 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 43 let want: Want = { 44 deviceId: '', // deviceId为空表示本设备 45 bundleName: 'com.example.myapplication', 46 abilityName: 'FuncAbility', 47 moduleName: 'entry' // moduleName非必选 48 }; 49 50 context.startAbility(want, (err: BusinessError) => { 51 if (err.code) { 52 // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability 53 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 54 } 55 }); 56 ``` 57 58- 目前支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等。 59 60 * 字符串（String） 61 ```ts 62 import { common, Want } from '@kit.AbilityKit'; 63 import { BusinessError } from '@kit.BasicServicesKit'; 64 65 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 66 let want: Want = { 67 bundleName: 'com.example.myapplication', 68 abilityName: 'FuncAbility', 69 parameters: { 70 keyForString: 'str', 71 }, 72 }; 73 74 context.startAbility(want, (err: BusinessError) => { 75 if (err.code) { 76 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 77 } 78 }); 79 ``` 80 * 数字（Number） 81 ```ts 82 import { common, Want } from '@kit.AbilityKit'; 83 84 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 85 let want: Want = { 86 bundleName: 'com.example.myapplication', 87 abilityName: 'FuncAbility', 88 parameters: { 89 keyForInt: 100, 90 keyForDouble: 99.99, 91 }, 92 }; 93 94 context.startAbility(want, (err) => { 95 if (err.code) { 96 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 97 } 98 }); 99 ``` 100 * 布尔（Boolean） 101 ```ts 102 import { common, Want } from '@kit.AbilityKit'; 103 import { BusinessError } from '@kit.BasicServicesKit'; 104 105 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 106 let want: Want = { 107 bundleName: 'com.example.myapplication', 108 abilityName: 'FuncAbility', 109 parameters: { 110 keyForBool: true, 111 }, 112 }; 113 114 context.startAbility(want, (err: BusinessError) => { 115 if (err.code) { 116 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 117 } 118 }); 119 ``` 120 * 对象（Object） 121 ```ts 122 import { common, Want } from '@kit.AbilityKit'; 123 import { BusinessError } from '@kit.BasicServicesKit'; 124 125 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 126 let want: Want = { 127 bundleName: 'com.example.myapplication', 128 abilityName: 'FuncAbility', 129 parameters: { 130 keyForObject: { 131 keyForObjectString: 'str', 132 keyForObjectInt: -200, 133 keyForObjectDouble: 35.5, 134 keyForObjectBool: false, 135 }, 136 }, 137 }; 138 139 context.startAbility(want, (err: BusinessError) => { 140 if (err.code) { 141 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 142 } 143 }); 144 ``` 145 * 数组（Array） 146 147 ```ts 148 import { common, Want } from '@kit.AbilityKit'; 149 import { BusinessError } from '@kit.BasicServicesKit'; 150 151 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 152 let want: Want = { 153 bundleName: 'com.example.myapplication', 154 abilityName: 'FuncAbility', 155 parameters: { 156 keyForArrayString: ['str1', 'str2', 'str3'], 157 keyForArrayInt: [100, 200, 300, 400], 158 keyForArrayDouble: [0.1, 0.2], 159 keyForArrayObject: [{ obj1: 'aaa' }, { obj2: 100 }], 160 }, 161 }; 162 163 context.startAbility(want, (err: BusinessError) => { 164 if (err.code) { 165 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 166 } 167 }); 168 ``` 169 170 * 文件描述符（FD） 171 172 ```ts 173 import { fileIo } from '@kit.CoreFileKit'; 174 import { common, Want } from '@kit.AbilityKit'; 175 import { BusinessError } from '@kit.BasicServicesKit'; 176 177 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 178 let fd: number = 0; 179 180 try { 181 fd = fileIo.openSync('/data/storage/el2/base/haps/pic.png').fd; 182 } catch(err) { 183 let code = (err as BusinessError).code; 184 let message = (err as BusinessError).message; 185 console.error(`Failed to openSync. Code: ${code}, message: ${message}`); 186 } 187 let want: Want = { 188 deviceId: '', // deviceId为空表示本设备 189 bundleName: 'com.example.myapplication', 190 abilityName: 'FuncAbility', 191 moduleName: 'entry', // moduleName非必选 192 parameters: { 193 'keyFd': { 'type': 'FD', 'value': fd } // {'type':'FD', 'value':fd}是固定用法，用于表示该数据是FD 194 } 195 }; 196 197 context.startAbility(want, (err: BusinessError) => { 198 if (err.code) { 199 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 200 } 201 }); 202 ``` 203 204 * parameter参数用法：parameter携带开发者自定义参数，由UIAbilityA传递给UIAbilityB，并在UIAbilityB中进行获取。 205 206 ```ts 207 // (1) UIAbilityA通过startability启动UIAbilityB 208 import { common, Want } from '@kit.AbilityKit'; 209 import { BusinessError } from '@kit.BasicServicesKit'; 210 211 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 212 let want: Want = { 213 bundleName: 'com.example.myapplication', 214 abilityName: 'UIAbilityB', 215 parameters: { 216 developerParameters: 'parameters', 217 }, 218 }; 219 220 context.startAbility(want, (err: BusinessError) => { 221 if (err.code) { 222 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 223 } 224 }); 225 ``` 226 227 ```ts 228 // (2) 以UIAbilityB实例首次启动为例，会进入到UIAbilityB的onCreate生命周期 229 import { UIAbility, Want, AbilityConstant } from '@kit.AbilityKit'; 230 231 class UIAbilityB extends UIAbility { 232 onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) { 233 console.log(`onCreate, want parameters: ${want.parameters?.developerParameters}`); 234 } 235 } 236 ``` 237 * parameter参数中[wantConstant](js-apis-app-ability-wantConstant.md)的Key的使用方法。 238 239 ```ts 240 import { common, Want, wantConstant } from '@kit.AbilityKit'; 241 import { BusinessError } from '@kit.BasicServicesKit'; 242 243 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 244 let want: Want = { 245 bundleName: 'com.example.myapplication', 246 abilityName: 'FuncAbility', 247 parameters: { 248 [wantConstant.Params.CONTENT_TITLE_KEY]: 'contentTitle', 249 }, 250 }; 251 252 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
