• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AbilityInfo
2<!--Kit: Ability Kit-->
3<!--Subsystem: BundleManager-->
4<!--Owner: @wanghang904-->
5<!--Designer: @hanfeng6-->
6<!--Tester: @kongjing2-->
7<!--Adviser: @Brilliantry_Rui-->
8
9The module provides information about an ability. Unless otherwise specified, the information is obtained through [bundle.getAbilityInfo](js-apis-Bundle.md#bundlegetabilityinfodeprecated).
10
11> **NOTE**
12>
13> 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.
14>
15> The APIs of this module are deprecated since API version 9. You are advised to use [bundleManager-AbilityInfo](js-apis-bundleManager-abilityInfo.md) instead.
16
17## AbilityInfo<sup>(deprecated)<sup>
18
19This API is deprecated since API version 9. You are advised to use [bundleManager-AbilityInfo](js-apis-bundleManager-abilityInfo.md#abilityinfo-1) instead.
20
21**System capability**: SystemCapability.BundleManager.BundleFramework
22
23| Name                 | Type                                                        | Read-Only| Optional| Description                                                        |
24| --------------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ |
25| bundleName            | string                                                       | Yes  | No  | Bundle name.                                            |
26| name                  | string                                                       | Yes  | No  | Ability name.                                               |
27| label                 | string                                                       | Yes  | No  | Ability name visible to users.                                   |
28| description           | string                                                       | Yes  | No  | Ability description.                                             |
29| icon                  | string                                                       | Yes  | No  | Index of the ability icon resource file.                                 |
30| descriptionId         | number                                                       | Yes  | No  | ID of the ability description.                                           |
31| iconId                | number                                                       | Yes  | No  | ID of the ability icon.                                           |
32| moduleName            | string                                                       | Yes  | No  | Name of the HAP file to which the ability belongs.                                    |
33| process               | string                                                       | Yes  | No  | Process name of the ability.                 |
34| targetAbility         | string                                                       | Yes  | No  | Target ability that the ability alias points to.<br>**Model restriction**: This API can be used only in the FA model.|
35| backgroundModes       | number                                                       | Yes  | No  | Background service mode of the ability.<br>**Model restriction**: This API can be used only in the FA model.        |
36| isVisible             | boolean                                                      | Yes  | No  | Whether the ability can be called by other applications. **true** if the ability can be called by other applications, **false** otherwise.                         |
37| formEnabled           | boolean                                                      | Yes  | No  | Whether the ability provides the service widget capability. **true** if the ability provides the service widget capability, **false** otherwise.<br>**Model restriction**: This API can be used only in the FA model.|
38| type                  | bundle.AbilityType                                                  | Yes  | No  | Ability type.<br>**Model restriction**: This API can be used only in the FA model.               |
39| orientation           | [bundle.DisplayOrientation](js-apis-Bundle.md#displayorientationdeprecated) | Yes  | No  | Ability display orientation.                                         |
40| launchMode            | [bundle.LaunchMode](js-apis-Bundle.md#launchmodedeprecated)         | Yes  | No  | Ability launch mode.                                         |
41| 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).|
42| deviceTypes           | Array\<string>                                               | Yes  | No  | Device types supported by the ability.                                     |
43| deviceCapabilities    | Array\<string>                                               | Yes  | No  | Device capabilities required for the ability.                                     |
44| readPermission        | string                                                       | Yes  | No  | Permission required for reading the ability data.<br>**Model restriction**: This API can be used only in the FA model. |
45| writePermission       | string                                                       | Yes  | No  | Permission required for writing data to the ability.<br>**Model restriction**: This API can be used only in the FA model. |
46| 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).|
47| uri                   | string                                                       | Yes  | No  | URI of the ability.<br>**Model restriction**: This API can be used only in the FA model.|
48| labelId               | number                                                       | Yes  | No  | ID of the ability label.                                           |
49| subType               | bundle.AbilitySubType                                               | Yes  | No  | Subtype of the template that can be used by the ability.<br>**Model restriction**: This API can be used only in the FA model.|
50| 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).|
51| enabled<sup>8+</sup>  | boolean                                                      | Yes  | No  | Whether the ability is enabled. **true** if enabled, **false** otherwise.                                           |
52