js-apis-app-ability-want.md 7.8 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.app.ability.Want (Want)
2

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

Y
yuyaozhi 已提交
5
> **说明:**
6
>
M
m00512953 已提交
7
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8 9 10

## 导入模块

M
m00512953 已提交
11 12
```ts
import Want from '@ohos.app.ability.Want';
13 14 15 16 17 18
```

## 属性

**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

19 20
| 名称        | 类型                 | 必填 | 说明                                                         |
| ----------- | -------------------- | ---- | ------------------------------------------------------------ |
W
wangkailong 已提交
21
| deviceId    | string               | 否   | 表示运行指定Ability的设备ID。如果未设置该字段,则表明指定本设备。                                |
22 23 24
| bundleName   | string               | 否   | 表示待启动Ability所在的应用Bundle名称。 |
| moduleName | string | 否 | 表示待启动的Ability所属的模块名称。 |
| abilityName  | string               | 否   | 表示待启动Ability名称。如果在Want中该字段同时指定了BundleName和AbilityName,则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
zyjhandsome's avatar
zyjhandsome 已提交
25 26
| action | string               | 否   | 表示要执行的通用操作(如:查看、分享、应用详情)。在隐式Want中,您可以定义该字段,配合uri或parameters来表示对数据要执行的操作。隐式Want定义及匹配规则请参见[显式Want与隐式Want匹配规则](../../application-models/explicit-implicit-want-mappings.md)。             |
| entities | Array\<string> | 否 | 表示目标Ability额外的类别信息(如:浏览器、视频播放器)。在隐式Want中是对action字段的补充。在隐式Want中,您可以定义该字段,来过滤匹配Ability类型。 |
27
| uri | string | 否 | 表示携带的数据,一般配合type使用,指明待处理的数据类型。如果在Want中指定了uri,则Want将匹配指定的Uri信息,包括`scheme``schemeSpecificPart``authority``path`信息。 |
M
mingxihua 已提交
28
| type | string | 否 | 表示MIME type类型描述,打开文件的类型,主要用于文管打开文件。比如:'text/xml' 、 'image/*'等,MIME定义请参见https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
M
mingxihua 已提交
29
| 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-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的上下文信息)
M
m00512953 已提交
35

M
m00512953 已提交
36
  ```ts
37 38 39 40 41 42 43 44 45 46 47
  let want = {
    'deviceId': '', // deviceId为空表示本设备
    'bundleName': 'com.example.myapplication',
    'abilityName': 'FuncAbility',
    'moduleName': 'entry' // moduleName非必选
  };
  
  this.context.startAbility(want, (err) => {
    // 显式拉起Ability,通过bundleName、abilityName和moduleName可以唯一确定一个Ability
    console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
  });
M
m00512953 已提交
48 49
  ```

50
- 通过自定字段传递数据,以下为当前支持类型(在UIAbility对象中调用,示例中的context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息))。
M
m00512953 已提交
51

52 53 54
    * 字符串(String)
        ```ts
        let want = {
55 56 57 58 59
          bundleName: 'com.example.myapplication',
          abilityName: 'FuncAbility',
          parameters: {
            keyForString: 'str',
          },
M
mingxihua 已提交
60
        };
61 62 63 64
        
        this.context.startAbility(want, (err) => {
          console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
        });
65 66 67 68
        ```
    * 数字(Number)
        ```ts
        let want = {
69 70 71 72 73 74
          bundleName: 'com.example.myapplication',
          abilityName: 'FuncAbility',
          parameters: {
            keyForInt: 100,
            keyForDouble: 99.99,
          },
M
mingxihua 已提交
75
        };
76 77 78 79
        
        this.context.startAbility(want, (err) => {
          console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
        });
80 81 82 83
        ```
    * 布尔(Boolean)
        ```ts
        let want = {
84 85 86 87 88
          bundleName: 'com.example.myapplication',
          abilityName: 'FuncAbility',
          parameters: {
            keyForBool: true,
          },
M
mingxihua 已提交
89
        };
90 91 92 93
        
        this.context.startAbility(want, (err) => {
          console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
        });
94 95 96 97
        ```
    * 对象(Object)
        ```ts
        let want = {
98 99 100 101 102 103 104 105
          bundleName: 'com.example.myapplication',
          abilityName: 'FuncAbility',
          parameters: {
            keyForObject: {
              keyForObjectString: 'str',
              keyForObjectInt: -200,
              keyForObjectDouble: 35.5,
              keyForObjectBool: false,
106
            },
107
          },
M
mingxihua 已提交
108
        };
109 110 111 112
        
        this.context.startAbility(want, (err) => {
          console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
        });
113 114 115 116
        ```
    * 数组(Array)
        ```ts
        let want = {
117 118 119 120 121 122 123 124
          bundleName: 'com.example.myapplication',
          abilityName: 'FuncAbility',
          parameters: {
            keyForArrayString: ['str1', 'str2', 'str3'],
            keyForArrayInt: [100, 200, 300, 400],
            keyForArrayDouble: [0.1, 0.2],
            keyForArrayObject: [{ obj1: 'aaa' }, { obj2: 100 }],
          },
M
mingxihua 已提交
125
        };
126 127 128 129
        
        this.context.startAbility(want, (err) => {
          console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
        });
130 131 132
        ```
    * 文件描述符(FD)
        ```ts
U
unknown 已提交
133
        import fs from '@ohos.file.fs';
134
        
135 136
        let fd;
        try {
U
unknown 已提交
137
            fd = fs.openSync('/data/storage/el2/base/haps/pic.png').fd;
138
        } catch(e) {
M
mingxihua 已提交
139
            console.error('openSync fail: ${JSON.stringify(e)}');
140 141
        }
        let want = {
142 143 144 145 146 147 148
          'deviceId': '', // deviceId为空表示本设备
          'bundleName': 'com.example.myapplication',
          'abilityName': 'FuncAbility',
          'moduleName': 'entry', // moduleName非必选
          'parameters': {
            'keyFd': { 'type': 'FD', 'value': fd } // {'type':'FD', 'value':fd}是固定用法,用于表示该数据是FD
          }
149
        };
150 151 152
        
        this.context.startAbility(want, (err) => {
          console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
M
mingxihua 已提交
153
        });
154
        ```
Y
yuyaozhi 已提交
155