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 '@ohos.app.ability.Want'; 13``` 14 15## 属性 16 17**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase 18 19| 名称 | 类型 | 必填 | 说明 | 20| ----------- | -------------------- | ---- | ------------------------------------------------------------ | 21| deviceId | string | 否 | 表示运行指定Ability的设备ID。如果未设置该字段，则表明指定本设备。 | 22| bundleName | string | 否 | 表示待启动Ability所在的应用Bundle名称。 | 23| moduleName | string | 否 | 表示待启动的Ability所属的模块名称。 | 24| abilityName | string | 否 | 表示待启动Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 | 25| action | string | 否 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。隐式Want定义及匹配规则请参见[显式Want与隐式Want匹配规则](../../application-models/explicit-implicit-want-mappings.md)。 | 26| entities | Array\<string> | 否 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器）。在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。 | 27| uri | string | 否 | 表示携带的数据，一般配合type使用，指明待处理的数据类型。如果在Want中指定了uri，则Want将匹配指定的Uri信息，包括`scheme`、`schemeSpecificPart`、`authority`和`path`信息。 | 28| type | string | 否 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如：'text/xml' 、 'image/*'等，MIME定义请参见https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | 29| parameters | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：<br />- ohos.aafwk.callerPid：表示拉起方的pid。<br />- ohos.aafwk.param.callerBundleName：表示拉起方的Bundle Name。<br />- ohos.aafwk.param.callerToken：表示拉起方的token。<br />- ohos.aafwk.param.callerUid：表示[BundleInfo](js-apis-bundleManager-bundleInfo.md#bundleinfo-1)中的uid，应用包里应用程序的uid。<br />- component.startup.newRules：表示是否启用新的管控规则。<br />- moduleName：表示拉起方的模块名，该字段的值即使定义成其他字符串，在传递到另一端时会被修改为正确的值。<br />- ohos.dlp.params.sandbox：表示dlp文件才会有。<br />- ability.params.backToOtherMissionStack：表示是否支持跨任务链返回。 | 30| [flags](js-apis-ability-wantConstant.md#wantconstantflags) | number | 否 | 表示处理Want的方式。默认传数字。<br />例如通过wantConstant.Flags.FLAG_ABILITY_CONTINUATION表示是否以设备间迁移方式启动Ability。 | 31 32**示例：** 33 34- 基础用法：在UIAbility对象中调用，示例中的context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。 35 36 ```ts 37 import common from '@ohos.app.ability.common'; 38 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 39 let want = { 40 'deviceId': '', // deviceId为空表示本设备 41 'bundleName': 'com.example.myapplication', 42 'abilityName': 'FuncAbility', 43 'moduleName': 'entry' // moduleName非必选 44 }; 45 46 context.startAbility(want, (err) => { 47 // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability 48 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 49 }); 50 ``` 51 52- 目前支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等。 53 54 * 字符串（String） 55 ```ts 56 import common from '@ohos.app.ability.common'; 57 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 58 let want = { 59 bundleName: 'com.example.myapplication', 60 abilityName: 'FuncAbility', 61 parameters: { 62 keyForString: 'str', 63 }, 64 }; 65 66 context.startAbility(want, (err) => { 67 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 68 }); 69 ``` 70 * 数字（Number） 71 ```ts 72 import common from '@ohos.app.ability.common'; 73 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 74 let want = { 75 bundleName: 'com.example.myapplication', 76 abilityName: 'FuncAbility', 77 parameters: { 78 keyForInt: 100, 79 keyForDouble: 99.99, 80 }, 81 }; 82 83 context.startAbility(want, (err) => { 84 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 85 }); 86 ``` 87 * 布尔（Boolean） 88 ```ts 89 import common from '@ohos.app.ability.common'; 90 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 91 let want = { 92 bundleName: 'com.example.myapplication', 93 abilityName: 'FuncAbility', 94 parameters: { 95 keyForBool: true, 96 }, 97 }; 98 99 context.startAbility(want, (err) => { 100 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 101 }); 102 ``` 103 * 对象（Object） 104 ```ts 105 import common from '@ohos.app.ability.common'; 106 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 107 let want = { 108 bundleName: 'com.example.myapplication', 109 abilityName: 'FuncAbility', 110 parameters: { 111 keyForObject: { 112 keyForObjectString: 'str', 113 keyForObjectInt: -200, 114 keyForObjectDouble: 35.5, 115 keyForObjectBool: false, 116 }, 117 }, 118 }; 119 120 context.startAbility(want, (err) => { 121 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 122 }); 123 ``` 124 * 数组（Array） 125 ```ts 126 import common from '@ohos.app.ability.common'; 127 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 128 let want = { 129 bundleName: 'com.example.myapplication', 130 abilityName: 'FuncAbility', 131 parameters: { 132 keyForArrayString: ['str1', 'str2', 'str3'], 133 keyForArrayInt: [100, 200, 300, 400], 134 keyForArrayDouble: [0.1, 0.2], 135 keyForArrayObject: [{ obj1: 'aaa' }, { obj2: 100 }], 136 }, 137 }; 138 139 context.startAbility(want, (err) => { 140 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 141 }); 142 ``` 143 * 文件描述符（FD） 144 ```ts 145 import fs from '@ohos.file.fs'; 146 147 import common from '@ohos.app.ability.common'; 148 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 149 150 let fd; 151 try { 152 fd = fs.openSync('/data/storage/el2/base/haps/pic.png').fd; 153 } catch(err) { 154 console.error(`Failed to openSync. Code: ${err.code}, message: ${err.message}`); 155 } 156 let want = { 157 'deviceId': '', // deviceId为空表示本设备 158 'bundleName': 'com.example.myapplication', 159 'abilityName': 'FuncAbility', 160 'moduleName': 'entry', // moduleName非必选 161 'parameters': { 162 'keyFd': { 'type': 'FD', 'value': fd } // {'type':'FD', 'value':fd}是固定用法，用于表示该数据是FD 163 } 164 }; 165 166 context.startAbility(want, (err) => { 167 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 168 }); 169 ``` 170 - parameter参数用法：以ability.params.backToOtherMissionStack为例，ServiceExtension在拉起UIAbility的时候，可以支持跨任务链返回。 171 172 ```ts 173 // (1) UIAbility1启动一个ServiceExtension 174 let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext 175 let want = { 176 bundleName: 'com.example.myapplication1', 177 abilityName: 'ServiceExtensionAbility', 178 }; 179 180 context.startAbility(want, (err) => { 181 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 182 }); 183 184 // (2) 该ServiceExtension去启动另一个UIAbility2，并在启动的时候携带参数ability.params.backToOtherMissionStack为true 185 let context = ...; // ServiceExtensionContext 186 let want = { 187 bundleName: 'com.example.myapplication2', 188 abilityName: 'MainAbility', 189 parameters: { 190 "ability.params.backToOtherMissionStack": true, 191 }, 192 }; 193 194 context.startAbility(want, (err) => { 195 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 196 }); 197 ``` 198 199 说明：上例中，如果ServiceExtension启动UIAbility2时不携带ability.params.backToOtherMissionStack参数，或者携带的ability.params.backToOtherMissionStack参数为false，则UIAbility1和UIAbility2不在同一个任务栈里面，在UIAbility2的界面点back键，不会回到UIAbility1的界面。如果携带的ability.params.backToOtherMissionStack参数为true，则表示支持跨任务链返回，此时在UIAbility2的界面点back键，会回到UIAbility1的界面。 200
