Want是对象间信息传递的载体，可以用于应用组件间的信息传递。Want的使用场景之一是作为startAbility的参数，其包含了指定的启动目标，以及启动时需携带的相关数据，如bundleName和abilityName字段分别指明目标Ability所在应用Bundle名称以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时，可使用Want作为载体将这些数据传递给Ability B。

说明

本模块首批接口从API version 8 开始支持，从API version 9废弃，替换模块为[@ohos.app.ability.Want](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-want)。后续版本的新增接口，采用上角标单独标记接口的起始版本。

## 导入模块

PhonePC/2in1TabletTVWearable



```
1. import Want from '@ohos.application.Want';
```

## Want

PhonePC/2in1TabletTVWearable

**系统能力**：SystemCapability.Ability.AbilityBase

展开

| 名称 | 类型 | 只读 | 可选 | 说明 |
| --- | --- | --- | --- | --- |
| deviceId | string | 否 | 是 | 表示运行指定Ability的设备ID。如果未设置该字段，则表明指定本设备。 |
| bundleName | string | 否 | 是 | 表示Bundle名称。 |
| abilityName | string | 否 | 是 | 表示待启动的Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | string | 否 | 是 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme、schemeSpecificPart、authority和path信息。 |
| type | string | 否 | 是 | 表示MIME type类型描述，打开文件的类型，主要用于文管打开文件。比如：'text/xml' 、 'image/\*'等，MIME定义参考：https://www.iana.org/assignments/media-types/media-types.xhtml?utm\_source=ld246.com。 |
| flags | number | 否 | 是 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-ability-wantconstant#flags)。 |
| action | string | 否 | 是 | 表示要执行的通用操作（如：查看、分享、应用详情）。在隐式Want中，您可以定义该字段，配合uri或parameters来表示对数据要执行的操作。具体参考：[action说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-ability-wantconstant#action)。隐式Want定义及匹配规则参考：[显式Want与隐式Want匹配规则](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/explicit-implicit-want-mappings)。 |
| parameters | { [key: string]: any } | 否 | 是 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：  ohos.aafwk.param.callerPid 表示拉起方的pid。  ohos.aafwk.param.callerToken 表示拉起方的token。  ohos.aafwk.param.callerUid 表示[bundleInfo](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-bundle-bundleinfo#bundleinfodeprecated)中的uid，应用包里应用程序的uid。  - component.startup.newRules：表示是否启用新的管控规则。  - moduleName：表示拉起方的模块名，该字段的值即使定义成其他字符串，在传递到另一端时会被修改为正确的值。  - ohos.dlp.params.sandbox：表示dlp文件才会有。 |
| entities | Array<string> | 否 | 是 | 表示目标Ability额外的类别信息（如：浏览器、视频播放器）。在隐式Want中是对action字段的补充。在隐式Want中，您可以定义该字段，来过滤匹配Ability类型。具体参考：[entity说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-ability-wantconstant#entity)。 |

**示例：**

* 基础用法(在UIAbility对象中调用，其中示例中的context为UIAbility的上下文对象)。

  

  ```
  1. import Want from '@ohos.application.Want';
  2. import { BusinessError } from '@ohos.base';
  3. import UIAbility from '@ohos.app.ability.UIAbility';
  4. import AbilityConstant from '@ohos.app.ability.AbilityConstant';

  6. let want: Want = {
  7. 'deviceId': '', // deviceId为空表示本设备
  8. 'bundleName': 'com.example.myapplication',
  9. 'abilityName': 'EntryAbility',
  10. };
  11. class MyAbility extends UIAbility{
  12. onCreate(want: Want, launchParam: AbilityConstant.LaunchParam){
  13. this.context.startAbility(want, (error: BusinessError) => {
  14. // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
  15. console.error(`error.code = ${error.code}`);
  16. });
  17. }
  18. }
  ```
* 通过自定字段传递数据，以下为当前支持类型(在UIAbility对象中调用，其中示例中的context为UIAbility的上下文对象)。

  + 字符串（String）

    

    ```
    1. import Want from '@ohos.application.Want';

    3. let want: Want = {
    4. bundleName: 'com.example.myapplication',
    5. abilityName: 'EntryAbility',
    6. parameters: {
    7. keyForString: 'str',
    8. },
    9. };
    ```
  + 数字（Number）

    

    ```
    1. import Want from '@ohos.application.Want';

    3. let want: Want = {
    4. bundleName: 'com.example.myapplication',
    5. abilityName: 'EntryAbility',
    6. parameters: {
    7. keyForInt: 100,
    8. keyForDouble: 99.99,
    9. },
    10. };
    ```
  + 布尔（Boolean）

    

    ```
    1. import Want from '@ohos.application.Want';

    3. let want: Want = {
    4. bundleName: 'com.example.myapplication',
    5. abilityName: 'EntryAbility',
    6. parameters: {
    7. keyForBool: true,
    8. },
    9. };
    ```
  + 对象（Object）

    

    ```
    1. import Want from '@ohos.application.Want';

    3. let want: Want = {
    4. bundleName: 'com.example.myapplication',
    5. abilityName: 'EntryAbility',
    6. parameters: {
    7. keyForObject: {
    8. keyForObjectString: 'str',
    9. keyForObjectInt: -200,
    10. keyForObjectDouble: 35.5,
    11. keyForObjectBool: false,
    12. },
    13. },
    14. };
    ```
  + 数组（Array）

    

    ```
    1. import Want from '@ohos.application.Want';

    3. let want: Want = {
    4. bundleName: 'com.example.myapplication',
    5. abilityName: 'EntryAbility',
    6. parameters: {
    7. keyForArrayString: ['str1', 'str2', 'str3'],
    8. keyForArrayInt: [100, 200, 300, 400],
    9. keyForArrayDouble: [0.1, 0.2],
    10. keyForArrayObject: [{obj1: 'aaa'}, {obj2: 100}],
    11. },
    12. };
    ```
  + 文件描述符（FD）

    

    ```
    1. import fileIo from '@ohos.file.fs';
    2. import Want from '@ohos.application.Want';
    3. import { BusinessError } from '@ohos.base';
    4. import AbilityConstant from '@ohos.app.ability.AbilityConstant';
    5. import UIAbility from '@ohos.app.ability.UIAbility';

    7. let fd: number = 0;
    8. try {
    9. fd = fileIo.openSync('/data/storage/el2/base/haps/pic.png').fd;
    10. } catch (e) {
    11. console.error(`OpenSync failed, error code: ${e.code}, error msg: ${e.message}.`);
    12. }
    13. let want: Want = {
    14. deviceId: '', // deviceId为空表示本设备
    15. bundleName: 'com.example.myapplication',
    16. abilityName: 'EntryAbility',
    17. parameters: {
    18. 'keyFd': { 'type': 'FD', 'value': fd }
    19. }
    20. };

    22. class MyAbility extends UIAbility {
    23. onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    24. this.context.startAbility(want, (error: BusinessError) => {
    25. // 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
    26. console.error(`StartAbility failed, error.code: ${error.code}, err msg: ${error.message}.`);
    27. });
    28. }
    29. }
    ```