HapModuleInfo

The HapModuleInfo module defines the HAP module information. A third-party application can obtain its own HAP module information through getBundleInfoForSelf, with GET_BUNDLE_INFO_WITH_HAP_MODULE passed in for bundleFlags.

NOTE

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.

HapModuleInfo

System capability: SystemCapability.BundleManager.BundleFramework.Core

Name Type Readable Writable Description
name string Yes No Module name.
icon string Yes No Module icon.
iconId number Yes No ID of the module icon.
label string Yes No Module label.
labelId number Yes No ID of the module label.
description string Yes No Module description.
descriptionId number Yes No ID of the module description.
mainElementName string Yes No Name of the main ability.
abilitiesInfo Array<AbilityInfo> Yes No Ability information. The information can be obtained by passing in GET_BUNDLE_INFO_WITH_HAP_MODULE and GET_BUNDLE_INFO_WITH_ABILITY to the bundleFlags parameter of getBundleInfoForSelf.
extensionAbilitiesInfo Array<ExtensionAbilityInfo> Yes No ExtensionAbility information. The information can be obtained by passing in GET_BUNDLE_INFO_WITH_HAP_MODULE and GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY to the bundleFlags parameter of getBundleInfoForSelf.
metadata Array<Metadata> Yes No Metadata of the ability. The information can be obtained by passing in GET_BUNDLE_INFO_WITH_HAP_MODULE and GET_BUNDLE_INFO_WITH_METADATA to the bundleFlags parameter of getBundleInfoForSelf.
deviceTypes Array<string> Yes No Types of devices where the module can run.
installationFree boolean Yes No Whether installation-free is supported.
hashValue string Yes No Hash value of the module.
type ModuleType Yes No Type of the module.
preloads Array<PreloadItem> Yes No Preloaded modules in the atomic service.
dependencies Array<Dependency> Yes No Dynamic shared libraries on which the module depends.
fileContextMenuConfig11+ string Yes No File menu configuration of the module. The information can be obtained by passing in GET_BUNDLE_INFO_WITH_HAP_MODULE and GET_BUNDLE_INFO_WITH_MENU to the bundleFlags parameter of getBundleInfoForSelf.

PreloadItem

Describes the preloaded module information in the atomic service.

System capability: SystemCapability.BundleManager.BundleFramework.Core

Name Type Readable Writable Description
moduleName string Yes No Name of the module automatically preloaded by the system.

Dependency

Describes the information about the dynamic shared library on which the module depends.

System capability: SystemCapability.BundleManager.BundleFramework.Core

Name Type Readable Writable Description
bundleName string Yes No Name of the shared bundle on which the current module depends.
moduleName string Yes No Module name of the shared bundle on which the current module depends.
versionCode number Yes No Version number of the shared bundle.