harmony 鸿蒙HapModuleInfo

2025-06-12
浏览 (3)

HapModuleInfo

HAP信息，可以通过getBundleInfoForSelf获取自身的HAP信息，其中参数bundleFlags至少包含GET_BUNDLE_INFO_WITH_HAP_MODULE。

说明： 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { bundleManager } from '@kit.AbilityKit';

HapModuleInfo

系统能力： SystemCapability.BundleManager.BundleFramework.Core

名称	类型	只读	可选	说明
name	string	是	否	模块名称。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
icon	string	是	否	模块图标。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
iconId	number	是	否	模块图标的资源id值。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
label	string	是	否	模块标签。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
labelId	number	是	否	模块标签的资源id值。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
description	string	是	否	模块描述信息。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
descriptionId	number	是	否	描述信息的资源id值。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
mainElementName	string	是	否	当前模块的入口UIAbility名称或者ExtensionAbility名称。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
abilitiesInfo	Array<AbilityInfo>	是	否	Ability信息。通过调用getBundleInfoForSelf接口，bundleFlags参数传入GET_BUNDLE_INFO_WITH_HAP_MODULE和GET_BUNDLE_INFO_WITH_ABILITY获取。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
extensionAbilitiesInfo	Array<ExtensionAbilityInfo>	是	否	ExtensionAbility信息。通过调用getBundleInfoForSelf接口，bundleFlags参数传入GET_BUNDLE_INFO_WITH_HAP_MODULE和GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY获取。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
metadata	Array<Metadata>	是	否	Ability的元信息。通过调用getBundleInfoForSelf接口，bundleFlags参数传入GET_BUNDLE_INFO_WITH_HAP_MODULE和GET_BUNDLE_INFO_WITH_METADATA获取。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
deviceTypes	Array<string>	是	否	模块支持安装的运行设备类型的集合。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
installationFree	boolean	是	否	模块是否支免安装（无需用户通过应用市场显式安装），取值为true表示支持免安装，取值为false表示不支持免安装。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
hashValue	string	是	否	模块的Hash值。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
type	bundleManager.ModuleType	是	否	标识当前模块的类型。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
preloads	Array<PreloadItem>	是	否	原子化服务中模块的预加载列表。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
dependencies	Array<Dependency>	是	否	模块运行依赖的动态共享库列表。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
fileContextMenuConfig¹¹⁺	string	是	否	模块的文件菜单配置。通过调用getBundleInfoForSelf接口，bundleFlags参数传入GET_BUNDLE_INFO_WITH_HAP_MODULE和GET_BUNDLE_INFO_WITH_MENU获取。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
routerMap¹²⁺	Array<RouterItem>	是	否	模块的路由表配置。通过调用getBundleInfoForSelf接口，bundleFlags参数传入GET_BUNDLE_INFO_WITH_HAP_MODULE和GET_BUNDLE_INFO_WITH_ROUTER_MAP获取。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
codePath¹²⁺	string	是	否	模块的安装路径。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
nativeLibraryPath¹²⁺	string	是	否	应用程序内模块本地库文件路径。

PreloadItem

描述原子化服务中模块的预加载模块信息。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.BundleManager.BundleFramework.Core

名称	类型	只读	可选	说明
moduleName	string	是	否	模块名称。

Dependency

描述模块所依赖的动态共享库信息。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.BundleManager.BundleFramework.Core

名称	类型	只读	可选	说明
bundleName¹⁰⁺	string	是	否	标识当前模块依赖的共享包包名。
moduleName	string	是	否	标识当前模块依赖的共享包模块名。
versionCode¹⁰⁺	number	是	否	标识当前共享包的版本号。

RouterItem¹²⁺

描述模块配置的路由表信息。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.BundleManager.BundleFramework.Core

名称	类型	只读	可选	说明
name	string	是	否	标识跳转页面的名称。
pageSourceFile	string	是	否	标识页面在模块内的路径。
buildFunction	string	是	否	标识被@Builder修饰的函数，该函数描述页面的UI。
data	Array<DataItem>	是	否	标识路由表配置文件中的字符串自定义数据，即data字段的信息，该字段已由系统解析，无需开发者自行解析。
customData	string	是	否	标识路由表配置文件中的任意类型的自定义数据，即customData字段的JSON字符串，开发者需要调用JSON.parse函数解析出具体内容。