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## Attributes
16
17**System capability**: SystemCapability.Ability.AbilityBase
18
19| Name       | Type                | Mandatory| Description                                                        |
20| ----------- | -------------------- | ---- | ------------------------------------------------------------ |
21| deviceId    | string               | No  | ID of the device running the ability. If this field is unspecified, the local device is used.                               |
22| bundleName   | string               | No  | Bundle name.|
23| 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.|
24| 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**.|
25| 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.  |
26| flags        | number               | No  | How the **Want** object will be handled. By default, numbers are passed in. For details, see [flags](js-apis-ability-wantConstant.md#flags).|
27| 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. For details, see [action](js-apis-ability-wantConstant.md#action). For details about the definition and matching rules of implicit Want, see [Matching Rules of Explicit Want and Implicit Want](../../application-models/explicit-implicit-want-mappings.md).                          |
28| parameters   | { [key: string]: any } | 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-bundleManager-bundleInfo.md#bundleinfo), 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.                                      |
29| 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.                                   |
30
31**Example**
32
33- Basic usage (called in a UIAbility object, where context in the example is the context object of the UIAbility).
34
35  ```ts
36  import AbilityConstant from '@ohos.app.ability.AbilityConstant';
37  import UIAbility from '@ohos.app.ability.UIAbility';
38  import Want from '@ohos.app.ability.Want';
39  import { BusinessError } from '@ohos.base';
40
41  let want: Want = {
42    deviceId: '', // An empty deviceId indicates the local device.
43    bundleName: 'com.example.myapplication',
44    abilityName: 'EntryAbility',
45    moduleName: 'entry', // moduleName is optional.
46  };
47  class MyAbility extends UIAbility{
48    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam){
49      this.context.startAbility(want, (error: BusinessError) => {
50        // Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability.
51        console.error(`error.code = ${error.code}`);
52      });
53    }
54  }
55  ```
56
57- Passing a file descriptor (FD) (called in a UIAbility object, where context in the example is the context object of the UIAbility):
58
59  ```ts
60  import fs from '@ohos.file.fs';
61  import Want from '@ohos.app.ability.Want';
62  import { BusinessError } from '@ohos.base';
63  import AbilityConstant from '@ohos.app.ability.AbilityConstant';
64  import UIAbility from '@ohos.app.ability.UIAbility';
65
66  // ...
67  let fd: number = 0;
68  try {
69    fd = fs.openSync('/data/storage/el2/base/haps/pic.png').fd;
70  } catch(e) {
71    console.error(`openSync fail: ${JSON.stringify(e)}`);
72  }
73
74
75  let want: Want = {
76    deviceId: '', // An empty deviceId indicates the local device.
77    bundleName: 'com.example.myapplication',
78    abilityName: 'EntryAbility',
79    moduleName: 'entry', // moduleName is optional.
80    parameters: {
81      'keyFd':{'type':'FD', 'value':fd}
82    }
83  };
84  class MyAbility extends UIAbility{
85    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam){
86      this.context.startAbility(want, (error: BusinessError) => {
87        // Start an ability explicitly. The bundleName, abilityName, and moduleName parameters work together to uniquely identify an ability.
88        console.error(`error.code = ${error.code}`);
89      });
90    }
91  }
92  // ...
93  ```
94
95