• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AbilityInfo
2
3The **AbilityInfo** module defines the ability information. A system application can obtain the ability information through [bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo). The input parameter [abilityFlags](js-apis-bundleManager.md#abilityflag) specifies the information to be contained in the returned [AbilityInfo](js-apis-bundleManager-abilityInfo.md) object.
4
5> **NOTE**
6>
7> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
8
9## AbilityInfo
10
11**System capability**: SystemCapability.BundleManager.BundleFramework.Core
12
13| Name                 | Type                                                    | Readable| Writable| Description                                     |
14| --------------------- | -------------------------------------------------------- | ---- | ---- | ------------------------------------------ |
15| bundleName            | string                                                   | Yes  | No  | Bundle name.                           |
16| moduleName            | string                                                   | Yes  | No  | Name of the HAP file to which the ability belongs.                   |
17| name                  | string                                                   | Yes  | No  | Ability name.                              |
18| label                 | string                                                   | Yes  | No  | Ability name visible to users.                  |
19| labelId               | number                                                   | Yes  | No  | ID of the ability label.                      |
20| description           | string                                                   | Yes  | No  | Ability description.                            |
21| descriptionId         | number                                                   | Yes  | No  | ID of the ability description.                      |
22| icon                  | string                                                   | Yes  | No  | Index of the ability icon resource file.                |
23| iconId                | number                                                   | Yes  | No  | ID of the ability icon.                      |
24| process               | string                                                   | Yes  | No  | Process in which the ability runs. If this parameter is not set, the bundle name is used.|
25| exported             | boolean                                                  | Yes  | No  | Whether the ability can be called by other bundles.        |
26| type                  | [AbilityType](js-apis-bundleManager.md#abilitytype)      | Yes  | No  | Ability type.<br>This attribute can be used only in the FA model.|
27| orientation           | [DisplayOrientation](js-apis-bundleManager.md#displayorientation)  | Yes  | No  | Ability display orientation.                        |
28| launchType            | [LaunchType](js-apis-bundleManager.md#launchtype)        | Yes  | No  | Ability launch mode.                        |
29| permissions           | Array\<string>                                           | Yes  | No  | Permissions required for other applications to call the ability. The permissions can be obtained by passing in **GET_ABILITY_INFO_WITH_PERMISSION** to the **abilityFlags** parameter of [bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo).|
30| readPermission        | string                                                   | Yes  | No  | Permission required for reading the ability data.<br>This attribute can be used only in the FA model.|
31| writePermission       | string                                                   | Yes  | No  | Permission required for writing data to the ability.<br>This attribute can be used only in the FA model.|
32| uri                   | string                                                   | Yes  | No  | URI of the ability.<br>This attribute can be used only in the FA model.|
33| deviceTypes           | Array\<string>                                           | Yes  | No  | Device types supported by the ability.                    |
34| applicationInfo       | [ApplicationInfo](js-apis-bundleManager-applicationInfo.md)     | Yes  | No  | Application information. The information can be obtained by passing in **GET_ABILITY_INFO_WITH_APPLICATION** to the **abilityFlags** parameter of [bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo).|
35| metadata              | Array\<[Metadata](js-apis-bundleManager-metadata.md)>           | Yes  | No  | Metadata of the ability. The information can be obtained by passing in **GET_ABILITY_INFO_WITH_METADATA** to the **abilityFlags** parameter of [bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo).|
36| enabled               | boolean                                                  | Yes  | No  | Whether the ability is enabled.                          |
37| supportWindowModes    | Array\<[SupportWindowMode](js-apis-bundleManager.md#supportwindowmode)> | Yes  | No  | Window modes supported by the ability.                     |
38| windowSize|[WindowSize](#windowsize)                                            |    Yes  | No  | Window size.|
39
40## WindowSize
41
42Describes the window size.
43
44**System capability**: SystemCapability.BundleManager.BundleFramework.Core
45
46| Name              | Type   | Readable| Writable| Description                              |
47| -------------------| ------- | ---- | ---- | ---------------------------------- |
48| maxWindowRatio     | number  | Yes  | No  | Maximum aspect ratio of the window in free window mode. The value ranges from 0 to 1.|
49| minWindowRatio     | number  | Yes  | No  | Minimum aspect ratio of the window in free window mode. The value ranges from 0 to 1.|
50| maxWindowWidth     | number  | Yes  | No  | Maximum width of the window in free window mode. The unit is vp.|
51| minWindowWidth     | number  | Yes  | No  | Minimum width of the window in free window mode. The unit is vp.|
52| maxWindowHeight    | number  | Yes  | No  | Maximum height of the window in free window mode. The unit is vp.|
53| minWindowHeight    | number  | Yes  | No  | Minimum height of the window in free window mode. The unit is vp.|
54