• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.application.Want (Want)
2
3Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的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               | 否   | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
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来表示对数据要执行的操作。                           |
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-1)中的uid，应用包里应用程序的uid。<br />- component.startup.newRules：表示是否启用新的管控规则。<br />- moduleName：表示拉起方的模块名，该字段的值即使定义成其他字符串，在传递到另一端时会被修改为正确的值。<br />- ohos.dlp.params.sandbox：表示dlp文件才会有。                                       |
29| entities    | Array\<string>       | 否   | 表示目标Ability额外的类别信息（如：浏览器、视频播放器），在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。                                    |
30
31**示例：**
32
33- 基础用法
34
35  ```ts
36    let want = {
37        'deviceId': '', // deviceId为空表示本设备
38        'bundleName': 'com.extreme.test',
39        'abilityName': 'MainAbility',
40        'moduleName': 'entry' // moduleName非必选
41    };
42    this.context.startAbility(want, (error) => {
43        // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
44        console.log('error.code = ' + error.code)
45    });
46  ```
47
48- 通过自定字段传递数据, 以下为当前支持类型。
49
50    * 字符串（String）
51        ```ts
52        let want = {
53            bundleName: 'com.example.demo',
54            abilityName: 'com.example.demo.MainAbility',
55            parameters: {
56                keyForString: 'str',
57            },
58        };
59        ```
60    * 数字（Number）
61        ```ts
62        let want = {
63            bundleName: 'com.example.demo',
64            abilityName: 'com.example.demo.MainAbility',
65            parameters: {
66                keyForInt: 100,
67                keyForDouble: 99.99,
68            },
69        };
70        ```
71    * 布尔（Boolean）
72        ```ts
73        let want = {
74            bundleName: 'com.example.demo',
75            abilityName: 'com.example.demo.MainAbility',
76            parameters: {
77                keyForBool: true,
78            },
79        };
80        ```
81    * 对象（Object）
82        ```ts
83        let want = {
84            bundleName: 'com.example.demo',
85            abilityName: 'com.example.demo.MainAbility',
86            parameters: {
87                keyForObject: {
88                    keyForObjectString: 'str',
89                    keyForObjectInt: -200,
90                    keyForObjectDouble: 35.5,
91                    keyForObjectBool: false,
92                },
93            },
94        };
95        ```
96    * 数组（Array）
97        ```ts
98        let want = {
99            bundleName: 'com.example.demo',
100            abilityName: 'com.example.demo.MainAbility',
101            parameters: {
102                keyForArrayString: ['str1', 'str2', 'str3'],
103                keyForArrayInt: [100, 200, 300, 400],
104                keyForArrayDouble: [0.1, 0.2],
105                keyForArrayObject: [{obj1: 'aaa'}, {obj2: 100}],
106            },
107        };
108        ```
109    * 文件描述符（FD）
110        ```ts
111            import fs from '@ohos.file.fs';
112            let fd;
113            try {
114                fd = fs.openSync('/data/storage/el2/base/haps/pic.png').fd;
115            } catch(e) {
116                console.log('openSync fail:' + JSON.stringify(e));
117            }
118            let want = {
119                'deviceId': '', // deviceId为空表示本设备
120                'bundleName': 'com.extreme.test',
121                'abilityName': 'MainAbility',
122                'moduleName': 'entry', // moduleName非必选
123                'parameters': {
124                    'keyFd':{'type':'FD', 'value':fd}
125                }
126            };
127            this.context.startAbility(want, (error) => {
128                // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
129                console.log('error.code = ' + error.code)
130            });
131        ```
132
133  <!--no_check-->