1# @ohos.application.Want (Want) 2 3Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用Bundle名称以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。 4 5> **说明:** 6> 7> 本模块首批接口从API version 8 开始支持,从API version 9废弃,替换模块为[@ohos.app.ability.Want](js-apis-app-ability-want.md)。后续版本的新增接口,采用上角标单独标记接口的起始版本。 8 9## 导入模块 10 11```ts 12import Want from '@ohos.application.Want'; 13``` 14 15## 属性 16 17**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase 18 19| 名称 | 类型 | 必填 | 说明 | 20| ----------- | -------------------- | ---- | ------------------------------------------------------------ | 21| deviceId | string | 否 | 表示运行指定Ability的设备ID。如果未设置该字段,则表明指定本设备。 | 22| bundleName | string | 否 | 表示Bundle名称。 | 23| abilityName | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 | 24| uri | string | 否 | 表示Uri描述。如果在Want中指定了Uri,则Want将匹配指定的Uri信息,包括scheme, schemeSpecificPart, authority和path信息。 | 25| type | string | 否 | 表示MIME type类型描述,打开文件的类型,主要用于文管打开文件。比如:'text/xml' 、 'image/*'等,MIME定义参考:https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 | 26| flags | number | 否 | 表示处理Want的方式。默认传数字,具体参考:[flags说明](js-apis-ability-wantConstant.md#wantconstantflags)。 | 27| action | string | 否 | 表示要执行的通用操作(如:查看、分享、应用详情)。在隐式Want中,您可以定义该字段,配合uri或parameters来表示对数据要执行的操作。具体参考:[action说明](js-apis-ability-wantConstant.md#wantconstantaction)。隐式Want定义及匹配规则参考:[显式Want与隐式Want匹配规则](../../application-models/explicit-implicit-want-mappings.md)。 | 28| parameters | {[key: string]: any} | 否 | 表示WantParams描述,由开发者自行决定传入的键值对。默认会携带以下key值:<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示[bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo)中的uid,应用包里应用程序的uid。<br />- component.startup.newRules:表示是否启用新的管控规则。<br />- moduleName:表示拉起方的模块名,该字段的值即使定义成其他字符串,在传递到另一端时会被修改为正确的值。<br />- ohos.dlp.params.sandbox:表示dlp文件才会有。 | 29| entities | Array\<string> | 否 | 表示目标Ability额外的类别信息(如:浏览器、视频播放器)。在隐式Want中是对action字段的补充。在隐式Want中,您可以定义该字段,来过滤匹配Ability类型。具体参考:[entity说明](js-apis-ability-wantConstant.md#wantconstantentity)。 | 30 31**示例:** 32 33- 基础用法(在UIAbility对象中调用,其中示例中的context为UIAbility的上下文对象) 34 35 ```ts 36 import Want from '@ohos.application.Want'; 37 import { BusinessError } from '@ohos.base'; 38 import UIAbility from '@ohos.app.ability.UIAbility'; 39 import AbilityConstant from '@ohos.app.ability.AbilityConstant'; 40 41 let want: Want = { 42 'deviceId': '', // deviceId为空表示本设备 43 'bundleName': 'com.example.myapplication', 44 'abilityName': 'EntryAbility', 45 }; 46 class MyAbility extends UIAbility{ 47 onCreate(want: Want, launchParam: AbilityConstant.LaunchParam){ 48 this.context.startAbility(want, (error: BusinessError) => { 49 // 显式拉起Ability,通过bundleName、abilityName和moduleName可以唯一确定一个Ability 50 console.error(`error.code = ${error.code}`); 51 }); 52 } 53 } 54 ``` 55 56- 通过自定字段传递数据, 以下为当前支持类型。(在UIAbility对象中调用,其中示例中的context为UIAbility的上下文对象) 57 58 * 字符串(String) 59 ```ts 60 import Want from '@ohos.application.Want'; 61 62 let want: Want = { 63 bundleName: 'com.example.myapplication', 64 abilityName: 'EntryAbility', 65 parameters: { 66 keyForString: 'str', 67 }, 68 }; 69 ``` 70 * 数字(Number) 71 ```ts 72 import Want from '@ohos.application.Want'; 73 74 let want: Want = { 75 bundleName: 'com.example.myapplication', 76 abilityName: 'EntryAbility', 77 parameters: { 78 keyForInt: 100, 79 keyForDouble: 99.99, 80 }, 81 }; 82 ``` 83 * 布尔(Boolean) 84 ```ts 85 import Want from '@ohos.application.Want'; 86 87 let want: Want = { 88 bundleName: 'com.example.myapplication', 89 abilityName: 'EntryAbility', 90 parameters: { 91 keyForBool: true, 92 }, 93 }; 94 ``` 95 * 对象(Object) 96 ```ts 97 import Want from '@ohos.application.Want'; 98 99 let want: Want = { 100 bundleName: 'com.example.myapplication', 101 abilityName: 'EntryAbility', 102 parameters: { 103 keyForObject: { 104 keyForObjectString: 'str', 105 keyForObjectInt: -200, 106 keyForObjectDouble: 35.5, 107 keyForObjectBool: false, 108 }, 109 }, 110 }; 111 ``` 112 * 数组(Array) 113 ```ts 114 import Want from '@ohos.application.Want'; 115 116 let want: Want = { 117 bundleName: 'com.example.myapplication', 118 abilityName: 'EntryAbility', 119 parameters: { 120 keyForArrayString: ['str1', 'str2', 'str3'], 121 keyForArrayInt: [100, 200, 300, 400], 122 keyForArrayDouble: [0.1, 0.2], 123 keyForArrayObject: [{obj1: 'aaa'}, {obj2: 100}], 124 }, 125 }; 126 ``` 127 * 文件描述符(FD) 128 ```ts 129 import fs from '@ohos.file.fs'; 130 import Want from '@ohos.application.Want'; 131 import { BusinessError } from '@ohos.base'; 132 import AbilityConstant from '@ohos.app.ability.AbilityConstant'; 133 import UIAbility from '@ohos.app.ability.UIAbility'; 134 135 136 let fd: number = 0; 137 try { 138 fd = fs.openSync('/data/storage/el2/base/haps/pic.png').fd; 139 } catch(e) { 140 console.error(`openSync fail: ${JSON.stringify(e)}`); 141 } 142 let want: Want = { 143 deviceId: '', // deviceId为空表示本设备 144 bundleName: 'com.example.myapplication', 145 abilityName: 'EntryAbility', 146 parameters: { 147 'keyFd':{'type':'FD', 'value':fd} 148 } 149 }; 150 151 class MyAbility extends UIAbility{ 152 onCreate(want: Want, launchParam: AbilityConstant.LaunchParam){ 153 this.context.startAbility(want, (error: BusinessError) => { 154 // 显式拉起Ability,通过bundleName、abilityName和moduleName可以唯一确定一个Ability 155 console.error(`error.code = ${error.code}`); 156 }); 157 } 158 } 159 ``` 160 161- 更多详细说明和示例请参见: [应用模型](../../application-models/application-model-composition.md)的信息传递载体Want 162 163 <!--no_check-->