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