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文件才会有。 | 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 let context = ...; // UIAbilityContext 38 let want = { 39 'deviceId': '', // deviceId为空表示本设备 40 'bundleName': 'com.example.myapplication', 41 'abilityName': 'FuncAbility', 42 'moduleName': 'entry' // moduleName非必选 43 }; 44 45 context.startAbility(want, (err) => { 46 // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability 47 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 48 }); 49 ``` 50 51- 目前支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等。 52 53 * 字符串（String） 54 ```ts 55 let context = ...; // UIAbilityContext 56 let want = { 57 bundleName: 'com.example.myapplication', 58 abilityName: 'FuncAbility', 59 parameters: { 60 keyForString: 'str', 61 }, 62 }; 63 64 context.startAbility(want, (err) => { 65 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 66 }); 67 ``` 68 * 数字（Number） 69 ```ts 70 let context = ...; // UIAbilityContext 71 let want = { 72 bundleName: 'com.example.myapplication', 73 abilityName: 'FuncAbility', 74 parameters: { 75 keyForInt: 100, 76 keyForDouble: 99.99, 77 }, 78 }; 79 80 context.startAbility(want, (err) => { 81 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 82 }); 83 ``` 84 * 布尔（Boolean） 85 ```ts 86 let context = ...; // UIAbilityContext 87 let want = { 88 bundleName: 'com.example.myapplication', 89 abilityName: 'FuncAbility', 90 parameters: { 91 keyForBool: true, 92 }, 93 }; 94 95 context.startAbility(want, (err) => { 96 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 97 }); 98 ``` 99 * 对象（Object） 100 ```ts 101 let context = ...; // UIAbilityContext 102 let want = { 103 bundleName: 'com.example.myapplication', 104 abilityName: 'FuncAbility', 105 parameters: { 106 keyForObject: { 107 keyForObjectString: 'str', 108 keyForObjectInt: -200, 109 keyForObjectDouble: 35.5, 110 keyForObjectBool: false, 111 }, 112 }, 113 }; 114 115 context.startAbility(want, (err) => { 116 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 117 }); 118 ``` 119 * 数组（Array） 120 ```ts 121 let context = ...; // UIAbilityContext 122 let want = { 123 bundleName: 'com.example.myapplication', 124 abilityName: 'FuncAbility', 125 parameters: { 126 keyForArrayString: ['str1', 'str2', 'str3'], 127 keyForArrayInt: [100, 200, 300, 400], 128 keyForArrayDouble: [0.1, 0.2], 129 keyForArrayObject: [{ obj1: 'aaa' }, { obj2: 100 }], 130 }, 131 }; 132 133 context.startAbility(want, (err) => { 134 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 135 }); 136 ``` 137 * 文件描述符（FD） 138 ```ts 139 import fs from '@ohos.file.fs'; 140 141 let context = ...; // UIAbilityContext 142 143 let fd; 144 try { 145 fd = fs.openSync('/data/storage/el2/base/haps/pic.png').fd; 146 } catch(err) { 147 console.error(`Failed to openSync. Code: ${err.code}, message: ${err.message}`); 148 } 149 let want = { 150 'deviceId': '', // deviceId为空表示本设备 151 'bundleName': 'com.example.myapplication', 152 'abilityName': 'FuncAbility', 153 'moduleName': 'entry', // moduleName非必选 154 'parameters': { 155 'keyFd': { 'type': 'FD', 'value': fd } // {'type':'FD', 'value':fd}是固定用法，用于表示该数据是FD 156 } 157 }; 158 159 context.startAbility(want, (err) => { 160 console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`); 161 }); 162 ``` 163
