• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AbilityInfo
2
3Unless otherwise specified, ability information is obtained through **GET_BUNDLE_DEFAULT**.
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>  API version 9 is a canary version for trial use. The APIs of this version may be unstable.
10
11## AbilityInfo
12
13**System capability**: SystemCapability.BundleManager.BundleFramework
14
15| Name                 | Type                                                    | Readable| Writable| Description                                     |
16| --------------------- | -------------------------------------------------------- | ---- | ---- | ----------------------------------------- |
17| bundleName            | string                                                   | Yes  | No  | Bundle name of the application.                                 |
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  | Ability description ID.                          |
23| iconId                | number                                                   | Yes  | No  | Ability icon ID.                          |
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. |
27| backgroundModes       | number                                                   | Yes  | No  | Background service mode of the ability.    |
28| isVisible             | boolean                                                  | Yes  | No  | Whether the ability can be called by other applications.        |
29| formEnabled           | boolean                                                  | Yes  | No  | Whether the ability provides the service widget capability. |
30| type                  | AbilityType                                              | Yes  | No  | Ability type.           |
31| orientation           | DisplayOrientation                                       | Yes  | No  | Ability display orientation.                        |
32| launchMode            | LaunchMode                                               | 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 **GET_ABILITY_INFO_WITH_PERMISSION**.|
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. |
37| writePermission       | string                                                   | Yes  | No  | Permission required for writing data to the ability. |
38| applicationInfo       | ApplicationInfo     | Yes  | No  | Application configuration information.<br>The value is obtained by passing **GET_ABILITY_INFO_WITH_APPLICATION**.|
39| uri                   | string                                                   | Yes  | No  | URI of the ability. |
40| labelId               | number                                                   | Yes  | No  | Ability label ID.                          |
41| subType               | AbilitySubType                                           | Yes  | No  | Subtype of the template that can be used by the ability. |
42| metaData<sup>8+</sup> | Array\<[CustomizeData](js-apis-bundle-CustomizeData.md)> | Yes  | No  | Custom metadata of the ability.<br>The value is obtained by passing **GET_ABILITY_INFO_WITH_METADATA**.|
43| metadata<sup>9+</sup> | Array\<[Metadata](js-apis-bundle-Metadata.md)>           | Yes  | No  | Metadata of the ability.<br>The value is obtained by passing **GET_ABILITY_INFO_WITH_METADATA**.|
44| enabled<sup>8+</sup>  | boolean                                                  | Yes  | No  | Whether the ability is enabled.                          |
45
46