• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AbilityInfo
2
3The **AbilityInfo** module provides information about an ability. Unless otherwise specified, the information is obtained through [bundle.getAbilityInfo](js-apis-Bundle.md#bundlegetabilityinfodeprecated).
4
5> **NOTE**
6>
7> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
8
9## AbilityInfo<sup>(deprecated)<sup>
10
11> This API is deprecated since API version 9. You are advised to use [bundleManager-AbilityInfo](js-apis-bundleManager-abilityInfo.md) instead.
12
13 **System capability**: SystemCapability.BundleManager.BundleFramework
14
15| Name                 | Type                                                        | Readable| Writable| Description                                                        |
16| --------------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ |
17| bundleName            | string                                                       | Yes  | No  | Bundle name.                                            |
18| name                  | string                                                       | Yes  | No  | Ability name.                                               |
19| label                 | string                                                       | Yes  | No  | Ability name visible to users.                                   |
20| description           | string                                                       | Yes  | No  | Ability description.                                             |
21| icon                  | string                                                       | Yes  | No  | Index of the ability icon resource file.                                 |
22| descriptionId         | number                                                       | Yes  | No  | ID of the ability description.                                           |
23| iconId                | number                                                       | Yes  | No  | ID of the ability icon.                                           |
24| moduleName            | string                                                       | Yes  | No  | Name of the HAP file to which the ability belongs.                                    |
25| process               | string                                                       | Yes  | No  | Process in which the ability runs. If this parameter is not set, the bundle name is used.                 |
26| targetAbility         | string                                                       | Yes  | No  | Target ability that the ability alias points to.<br>This attribute can be used only in the FA model.|
27| backgroundModes       | number                                                       | Yes  | No  | Background service mode of the ability.<br>This attribute can be used only in the FA model.        |
28| isVisible             | boolean                                                      | Yes  | No  | Whether the ability can be called by other bundles.                         |
29| formEnabled           | boolean                                                      | Yes  | No  | Whether the ability provides the service widget capability.<br>This attribute can be used only in the FA model.|
30| type                  | AbilityType                                                  | Yes  | No  | Ability type.<br>This attribute can be used only in the FA model.               |
31| orientation           | [DisplayOrientation](js-apis-Bundle.md#displayorientationdeprecated) | Yes  | No  | Ability display orientation.                                         |
32| launchMode            | [LaunchMode](js-apis-Bundle.md#launchmodedeprecated)         | Yes  | No  | Ability launch mode.                                         |
33| permissions           | Array\<string>                                               | Yes  | No  | Permissions required for other applications to call the ability.<br>The value is obtained by passing in GET_ABILITY_INFO_WITH_PERMISSION to [bundle.getAbilityInfo](js-apis-Bundle.md#bundlegetabilityinfodeprecated).|
34| deviceTypes           | Array\<string>                                               | Yes  | No  | Device types supported by the ability.                                     |
35| deviceCapabilities    | Array\<string>                                               | Yes  | No  | Device capabilities required for the ability.                                     |
36| readPermission        | string                                                       | Yes  | No  | Permission required for reading the ability data.<br>This attribute can be used only in the FA model. |
37| writePermission       | string                                                       | Yes  | No  | Permission required for writing data to the ability.<br>This attribute can be used only in the FA model. |
38| applicationInfo       | [ApplicationInfo](js-apis-bundle-ApplicationInfo.md)         | Yes  | No  | Application configuration information.<br>The value is obtained by passing in GET_ABILITY_INFO_WITH_APPLICATION to [bundle.getAbilityInfo](js-apis-Bundle.md#bundlegetabilityinfodeprecated).|
39| uri                   | string                                                       | Yes  | No  | URI of the ability.<br>This attribute can be used only in the FA model.|
40| labelId               | number                                                       | Yes  | No  | ID of the ability label.                                           |
41| subType               | AbilitySubType                                               | Yes  | No  | Subtype of the template that can be used by the ability.<br>This attribute can be used only in the FA model.|
42| metadata<sup>8+</sup> | Array\<[CustomizeData](js-apis-bundle-CustomizeData.md)>     | Yes  | No  | Metadata of the ability.<br>The value is obtained by passing in GET_ABILITY_INFO_WITH_METADATA to [bundle.getAbilityInfo](js-apis-Bundle.md#bundlegetabilityinfodeprecated).|
43| enabled<sup>8+</sup>  | boolean                                                      | Yes  | No  | Whether the ability is enabled.                                           |
44