AbilityInfo

Ability信息,可以通过bundleManager.getBundleInfoForSelf获取Ability信息,其中参数bundleFlags至少包含GET_BUNDLE_INFO_WITH_HAP_MODULE和GET_BUNDLE_INFO_WITH_ABILITY。

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

导入模块

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

AbilityInfo

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

名称 类型 只读 可选 说明
bundleName string 应用Bundle名称。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
moduleName string Ability所属的模块名称。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
name string Ability名称。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
label string Ability对用户显示的名称的资源描述符,对应module.json5中abilities下配置的label字段。
说明: 从API version 20开始,如果是通过bundleManager.getAbilityInfo获取Ability信息,该字段为Ability对用户显示的名称。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
labelId number Ability的标签资源id,是编译构建时根据应用配置abilities下的label自动生成的资源id。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
description string Ability的描述,对应module.json5中abilities下配置的description字段,用于描述当前ability提供的页面内容和功能作用。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
descriptionId number Ability的描述资源id,是编译构建时根据应用配置abilities下的description自动生成的资源id。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
icon string Ability的图标资源描述符,对应module.json5中abilities下配置的icon字段。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
iconId number Ability的图标资源id,是编译构建时根据应用配置abilities下的icon自动生成的资源id。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
process string Ability的进程名称。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
exported boolean 判断Ability是否可以被其他应用拉起,取值为true表示Ability可以被其他应用拉起,取值为false表示Ability不可以被其他应用拉起。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
type bundleManager.AbilityType Ability类型。
模型约束: 此接口仅可在FA模型下使用。
orientation bundleManager.DisplayOrientation Ability的显示模式。来源于module.json5中abilities标签下配置的orientation字段,如果module.json5配置文件中orientation配置枚举,orientation属性有值且非0,取值详情参考显示模式枚举;如果配置文件中配置的是资源索引,orientation属性值为0。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
launchType bundleManager.LaunchType Ability的启动模式,在启动的时候是否以多实例启动,详情参考启动模式枚举
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
permissions Array<string> 被其他应用拉起/访问时,其他应用需要申请的权限集合,只有当前AbilityInfo的exported为true,即当前Ability可以被其他应用拉起时,才会查看其他应用是否存在拉起/访问的权限。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
readPermission string 读取Ability数据所需的权限。
模型约束: 此接口仅可在FA模型下使用。
writePermission string 向Ability写数据所需的权限。
模型约束: 此接口仅可在FA模型下使用。
uri string 获取Ability的统一资源标识符(URI)。
模型约束: 此接口仅可在FA模型下使用。
deviceTypes Array<string> Ability支持的设备类型,来源于module.json5配置的deviceTypes
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
applicationInfo ApplicationInfo 应用程序的配置信息,可以通过调用queryAbilityInfo接口,abilityFlags参数传入GET_ABILITY_INFO_WITH_APPLICATION获取。
getBundleInfoForSelf或者getBundleInfo接口获取AbilityInfo信息时不会返回该字段内容,可以通过获取bundleInfo.appInfo对象来获取相关信息。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
metadata Array<Metadata> Ability的元信息。可以配置成系统定义的参数,使用系统提供的能力,例如快捷方式窗口元数据配置等。也可以自定义配置参数,通过调用getBundleInfoForSelf接口,bundleFlags参数传入GET_BUNDLE_INFO_WITH_HAP_MODULE、GET_BUNDLE_INFO_WITH_ABILITY和GET_BUNDLE_INFO_WITH_METADATA获取。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
enabled boolean Ability是否可用,可用表示可以拉起或者查询,不可用时调用getAbilityInfo查询ability需要携带GET_ABILITY_INFO_WITH_DISABLE的AbilityFlag,取值为true表示Ability可用,取值为false表示Ability不可用。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
supportWindowModes Array<bundleManager.SupportWindowMode> Ability支持的窗口模式。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
windowSize WindowSize Ability窗口尺寸。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
excludeFromDock12+ boolean 判断Ability是否可以在dock区域隐藏图标,取值为true表示可以隐藏,取值为false不可以隐藏。
说明: 该字段不生效。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
skills12+ Array<Skill> Ability的Skills信息,标识UIAbility组件或者ExtensionAbility组件能够接收的Want的特征。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
appIndex12+ number 应用包的分身索引标识,仅在分身应用中生效。
orientationId14+ number Ability的显示模式资源id。来源于module.json5中abilities标签下的orientation字段,如果module.json5配置文件中orientation配置枚举,orientationId属性值为0;如果配置文件中配置的是资源索引,orientationId属性值为非0,为编译构建时生成的资源id索引。当orientationId不为0时表示当前显示模式为自定义配置,需要使用orientationId去资源管理获取对应的资源,当orientationId为0时表示未配置资源。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。

WindowSize

描述窗口尺寸。


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

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

名称 类型 只读 可选 说明
maxWindowRatio number 表示自由窗口状态下窗口的最大宽高比;取值范围0-1,例如:0.12。
minWindowRatio number 表示自由窗口状态下窗口的最小宽高比;取值范围0-1,例如:0.5。
maxWindowWidth number 表示自由窗口状态下窗口的最大宽度,宽度单位为vp。
minWindowWidth number 表示自由窗口状态下窗口的最小宽度,宽度单位为vp。
maxWindowHeight number 表示自由窗口状态下窗口的最大高度,高度单位为vp。
minWindowHeight number 表示自由窗口状态下窗口的最小高度,高度单位为vp。