• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# HapModuleInfo
2<!--Kit: Ability Kit-->
3<!--Subsystem: BundleManager-->
4<!--Owner: @wanghang904-->
5<!--Designer: @hanfeng6-->
6<!--Tester: @kongjing2-->
7<!--Adviser: @Brilliantry_Rui-->
8
9The HapModuleInfo module provides information about an HAP module. Unless otherwise specified, the information is obtained through [bundle.getBundleInfo](js-apis-Bundle.md#bundlegetbundleinfodeprecated).
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-HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md) instead.
16
17## HapModuleInfo<sup>(deprecated)<sup>
18
19This API is deprecated since API version 9. You are advised to use [bundleManager-HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md#hapmoduleinfo-1) instead.
20
21**System capability**: SystemCapability.BundleManager.BundleFramework
22
23| Name                             | Type                                                        | Read-Only| Optional| Description                |
24| --------------------------------- | ------------------------------------------------------------ | ---- | ---- | -------------------- |
25| name                              | string                                                       | Yes  | No  | Module name.            |
26| description                       | string                                                       | Yes  | No  | Module description.        |
27| descriptionId                     | number                                                       | Yes  | No  | Module description ID.          |
28| icon                              | string                                                       | Yes  | No  | Module icon.            |
29| label                             | string                                                       | Yes  | No  | Module label.            |
30| labelId                           | number                                                       | Yes  | No  | Module label ID.          |
31| iconId                            | number                                                       | Yes  | No  | Module icon ID.          |
32| backgroundImg                     | string                                                       | Yes  | No  | Module background image.        |
33| supportedModes                    | number                                                       | Yes  | No  | Running modes supported by the module.      |
34| reqCapabilities                   | Array\<string>                                               | Yes  | No  | Capabilities required for module running.  |
35| deviceTypes                       | Array\<string>                                               | Yes  | No  | Device types supported by the module.  |
36| abilityInfo                       | Array\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)>         | Yes  | No  | Ability information.         |
37| moduleName                        | string                                                       | Yes  | No  | Module name.              |
38| mainAbilityName                   | string                                                       | Yes  | No  | Name of the main ability.     |
39| installationFree                  | boolean                                                      | Yes  | No  | Whether installation-free is supported. **true** if supported, **false** otherwise.      |
40