• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Want
2
3Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为[startAbility](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。
4
5> **说明:**
6>
7> 本模块首批接口从API version 6开始支持,从API version 9废弃,使用[@ohos.app.ability.Want](js-apis-app-ability-want.md)模块替代。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
10
11| 名称        | 类型                 | 必填 | 说明                                                         |
12| ----------- | -------------------- | ---- | ------------------------------------------------------------ |
13| deviceId    | string               | 否   | 表示运行指定Ability的设备ID。                                |
14| bundleName   | string               | 否   | 表示包名。如果在Want中同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。 |
15| abilityName  | string               | 否   | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
16| uri          | string               | 否   | 表示Uri。如果在Want中指定了Uri,则Want将匹配指定的Uri信息,包括scheme, schemeSpecificPart, authority和path信息。 |
17| type         | string               | 否   | 表示MIME type类型,打开文件的类型,主要用于文管打开文件。比如:'text/xml' 、 'image/*'等,MIME定义参考:https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。   |
18| flags        | number               | 否   | 表示处理Want的方式。默认传数字,具体参考:[flags说明](js-apis-app-ability-wantConstant.md#wantconstantflags)。 |
19| action      | string               | 否   | 表示要执行的通用操作(如:查看、分享、应用详情)。在隐式Want中,您可以定义该字段,配合uri或parameters来表示对数据要执行的操作。                           |
20| parameters   | {[key: string]: Object} | 否   | 表示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文件才会有。                                       |
21| entities    | Array\<string>       | 否   | 表示目标Ability额外的类别信息(如:浏览器、视频播放器),在隐式Want中是对action字段的补充。在隐式Want中,您可以定义该字段,来过滤匹配Ability类型。                                    |
22| moduleName<sup>9+</sup> | string | 否    | 表示待启动的Ability所属的模块(module)。 |
23
24**示例:**
25
26- 基础用法(在UIAbility对象中调用,其中示例中的context为UIAbility的上下文对象)
27
28  ```ts
29  let want = {
30      'deviceId': '', // deviceId为空表示本设备
31      'bundleName': 'com.extreme.test',
32      'abilityName': 'MainAbility',
33      'moduleName': 'entry' // moduleName非必选
34  };
35  this.context.startAbility(want, (error) => {
36      // 显式拉起Ability,通过bundleName、abilityName和moduleName可以唯一确定一个Ability
37      console.log('error.code = ' + error.code)
38  });
39  ```
40
41- 传递FD(文件描述符)数据(在UIAbility对象中调用,其中示例中的context为UIAbility的上下文对象)
42
43  ```ts
44  import fs from '@ohos.file.fs';
45
46  // ...
47  let fd;
48  try {
49      fd = fs.openSync('/data/storage/el2/base/haps/pic.png').fd;
50  } catch(e) {
51      console.log('openSync fail:' + JSON.stringify(e));
52  }
53  let want = {
54      'deviceId': '', // deviceId为空表示本设备
55      'bundleName': 'com.extreme.test',
56      'abilityName': 'MainAbility',
57      'moduleName': 'entry', // moduleName非必选
58      'parameters': {
59          'keyFd':{'type':'FD', 'value':fd}
60      }
61  };
62  this.context.startAbility(want, (error) => {
63      // 显式拉起Ability,通过bundleName、abilityName和moduleName可以唯一确定一个Ability
64      console.log('error.code = ' + error.code)
65  });
66  // ...
67  ```
68
69- 更多详细说明和示例请参见: [应用模型](../../application-models/application-model-composition.md)的信息传递载体Want
70
71  <!--no_check-->