• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Want
2
3Want is a carrier for information transfer between objects (application components). Want can be used as a parameter of [startAbility](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability) to specify a startup target and information that needs to be carried during startup, for example, **bundleName** and **abilityName**, which respectively indicate the bundle name of the target ability and the ability name in the bundle. When ability A needs to start ability B and transfer some data to ability B, it can use Want a carrier to transfer the data.
4
5> **NOTE**
6>
7> The APIs of this module are supported since API version 6 and deprecated since API version 9. You are advised to use [@ohos.app.ability.Want](js-apis-app-ability-want.md) instead. Newly added APIs will be marked with a superscript to indicate their earliest API version.
8
9## Modules to Import
10
11```ts
12import Want from '@ohos.app.ability.Want';
13```
14
15**System capability**: SystemCapability.Ability.AbilityBase
16
17| Name       | Type                | Mandatory| Description                                                        |
18| ----------- | -------------------- | ---- | ------------------------------------------------------------ |
19| deviceId    | string               | No  | ID of the device running the ability.                               |
20| bundleName   | string               | No  | Bundle name.|
21| abilityName  | string               | No  | Name of the ability. If both **bundleName** and **abilityName** are specified in a **Want** object, the **Want** object can match a specific ability. The value of **abilityName** must be unique in an application.|
22| uri          | string               | No  | URI. If **uri** is specified in a **Want** object, the **Want** object will match the specified URI information, including **scheme**, **schemeSpecificPart**, **authority**, and **path**.|
23| type         | string               | No  | MIME type, that is, the type of the file to open, for example, **'text/xml'** and **'image/*'**. For details about the MIME type definition, see https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com.  |
24| flags        | number               | No  | How the **Want** object will be handled. By default, numbers are passed in. For details, see [flags](js-apis-app-ability-wantConstant.md#wantconstantflags).|
25| action      | string               | No  | Action to take, such as viewing and sharing application details. In implicit Want, you can define this field and use it together with **uri** or **parameters** to specify the operation to be performed on the data.                           |
26| parameters   | {[key: string]: Object} | No  | Want parameters in the form of custom key-value (KV) pairs. By default, the following keys are carried:<br>- **ohos.aafwk.callerPid**: PID of the caller.<br>- **ohos.aafwk.param.callerToken**: token of the caller.<br>- **ohos.aafwk.param.callerUid**: UID in [bundleInfo](js-apis-bundle-BundleInfo.md#bundleinfo-1), that is, the application UID in the bundle information.<br>- **component.startup.newRules**: whether to enable the new control rule.<br>- **moduleName**: module name of the caller. No matter what this field is set to, the correct module name will be sent to the peer.<br>- **ohos.dlp.params.sandbox**: available only for DLP files.                                  |
27| entities    | Array\<string>       | No  | Additional category information (such as browser and video player) of the target ability. It is a supplement to **action** in implicit Want and is used to filter ability types.                                    |
28| moduleName<sup>9+</sup> | string | No   | Module to which the ability belongs.|
29
30**Example**
31
32- Basic usage (called in a UIAbility object, where context in the example is the context object of the UIAbility).
33
34  ```ts
35  let want = {
36      'deviceId': '', // An empty deviceId indicates the local device.
37      'bundleName': 'com.extreme.test',
38      'abilityName': 'MainAbility',
39      'moduleName': 'entry' // moduleName is optional.
40  };
41  this.context.startAbility(want, (error) => {
42      // Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability.
43      console.log('error.code = ' + error.code)
44  });
45  ```
46
47- Passing a file descriptor (FD) (called in the UIAbility object, where context in the example is the context object of the UIAbility):
48
49  ```ts
50  import fs from '@ohos.file.fs';
51
52  // ...
53  let fd;
54  try {
55      fd = fs.openSync('/data/storage/el2/base/haps/pic.png').fd;
56  } catch(e) {
57      console.log('openSync fail:' + JSON.stringify(e));
58  }
59  let want = {
60      'deviceId': '', // An empty deviceId indicates the local device.
61      'bundleName': 'com.extreme.test',
62      'abilityName': 'MainAbility',
63      'moduleName': 'entry', // moduleName is optional.
64      'parameters': {
65          'keyFd':{'type':'FD', 'value':fd}
66      }
67  };
68  this.context.startAbility(want, (error) => {
69      // Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability.
70      console.log('error.code = ' + error.code)
71  });
72  // ...
73  ```
74
75- For more details and examples, see [Want](../../application-models/want-overview.md).
76
77