文档管理中心

您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明。

指南与API参考API参考应用框架Ability Kit(程序框架服务)ArkTS API通用能力的接口(推荐)@ohos.app.ability.abilityManager (Ability信息管理)

@ohos.app.ability.abilityManager (Ability信息管理)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

AbilityManager模块提供获取Ability相关信息和运行状态信息的能力。

说明

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

导入模块

收起
自动换行
深色代码主题
复制
  1. import { abilityManager } from '@kit.AbilityKit';

AbilityState14+

Phone14+PC/2in114+Tablet14+TV19+Wearable18+

Ability的状态,该类型为枚举,可配合AbilityRunningInfo返回Ability的状态。

系统能力:SystemCapability.Ability.AbilityRuntime.Core

展开
名称 值 说明
INITIAL 0 表示ability为初始化状态。
FOCUS 2 表示ability为获焦状态。
FOREGROUND 9 表示ability为前台状态。
BACKGROUND 10 表示ability为后台状态。
FOREGROUNDING 11 表示ability为前台调度中状态。
BACKGROUNDING 12 表示ability为后台调度中状态。

abilityManager.getAbilityRunningInfos14+

Phone14+PC/2in114+Tablet14+TV19+Wearable18+

getAbilityRunningInfos(): Promise<Array<AbilityRunningInfo>>

获取UIAbility运行时的相关信息。使用Promise异步回调。

说明

如果应用申请了ohos.permission.GET_RUNNING_INFO权限,可以获取所有应用UIAbility的运行信息,否则只能获取当前应用UIAbility的运行信息。

需要权限:ohos.permission.GET_RUNNING_INFO

系统能力:SystemCapability.Ability.AbilityRuntime.Core

返回值:

展开
类型 说明
Promise<Array<AbilityRunningInfo>> Promise对象,返回UIAbility运行时的相关信息。开发者可在此进行错误处理或其他自定义处理。

错误码:

以下错误码详细介绍请参考元能力子系统错误码。

展开
错误码ID 错误信息
16000050 Internal error.

示例:

收起
自动换行
深色代码主题
复制
  1. import { abilityManager } from '@kit.AbilityKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. try {
  4. abilityManager.getAbilityRunningInfos()
  5. .then((data: abilityManager.AbilityRunningInfo[]) => {
  6. console.info(`getAbilityRunningInfos success, data: ${JSON.stringify(data)}`);
  7. })
  8. .catch((error: BusinessError) => {
  9. console.error(`getAbilityRunningInfos fail, error code: ${JSON.stringify(error.code)}, error msg: ${JSON.stringify(error.message)}`);
  10. })
  11. } catch (e) {
  12. let code = (e as BusinessError).code;
  13. let msg = (e as BusinessError).message;
  14. console.error(`getAbilityRunningInfos fail, error code: ${JSON.stringify(code)}, error msg: ${JSON.stringify(msg)}`);
  15. }

abilityManager.restartSelfAtomicService20+

Phone20+PC/2in120+Tablet20+TV20+Wearable20+

restartSelfAtomicService(context: Context): void

重启当前元服务。

说明

模型约束:此接口仅可在Stage模型下使用。

系统能力:SystemCapability.Ability.AbilityRuntime.Core

元服务API:从API version 20开始,该接口支持在元服务中使用。

参数:

展开
参数名 类型 必填 说明
context Context 是

当前Ability的上下文。

说明:当前仅支持UIAbilityContext。

错误码:

以下错误码详细介绍请参考元能力子系统错误码。

展开
错误码ID 错误信息
16000050 Internal error. Possible causes: 1. Connect to system service failed; 2.Send restart message to system service failed; 3.System service failed to communicate with dependency module.
16000053 The ability is not on the top of the UI.
16000064 Restart too frequently. Try again at least 3s later.
16000086 The context is not UIAbilityContext.
16000090 The caller is not an atomic service.

示例:

收起
自动换行
深色代码主题
复制
  1. import { AbilityConstant, EmbeddableUIAbility, Want, abilityManager } from '@kit.AbilityKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. export default class EntryAbility extends EmbeddableUIAbility {
  4. onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
  5. try {
  6. abilityManager.restartSelfAtomicService(this.context);
  7. } catch (e) {
  8. console.error(`restartSelfAtomicService error: ${JSON.stringify(e as BusinessError)}`);
  9. }
  10. }
  11. }

abilityManager.isEmbeddedUIExtensionSupported

Phone26.0.0+PC/2in126.0.0+Tablet26.0.0+TV26.0.0+Wearable26.0.0+

isEmbeddedUIExtensionSupported(): boolean

开发者通过调用该接口判断EmbeddedUIExtensionAbility是否可以在当前设备上使用。

起始版本:26.0.0

模型约束:此接口仅可在Stage模型下使用。

系统能力:SystemCapability.Ability.AbilityRuntime.Core

返回值:

展开
类型 说明
boolean 当前设备是否支持EmbeddedUIExtensionAbility。返回true表示当前设备支持;返回false表示当前设备不支持。

示例:

收起
自动换行
深色代码主题
复制
  1. import { abilityManager, UIAbility } from '@kit.AbilityKit';
  2. export default class EntryAbility extends UIAbility {
  3. onForeground() {
  4. let isSupported: boolean = abilityManager.isEmbeddedUIExtensionSupported();
  5. console.info(`isEmbeddedUIExtensionSupported is ${isSupported}`);
  6. }
  7. }

AbilityRunningInfo14+

Phone14+PC/2in114+Tablet14+TV19+Wearable18+

type AbilityRunningInfo = _AbilityRunningInfo

AbilityRunningInfo二级模块。

系统能力:SystemCapability.Ability.AbilityRuntime.Core

展开
类型 说明
_AbilityRunningInfo AbilityRunningInfo二级模块,提供对Ability运行的相关信息和状态的定义。

AbilityStateData14+

Phone14+PC/2in114+Tablet14+TV19+Wearable18+

type AbilityStateData = _AbilityStateData.default

AbilityStateData二级模块。

系统能力:SystemCapability.Ability.AbilityRuntime.Core

展开
类型 说明
_AbilityStateData.default AbilityStateData二级模块,提供Ability状态信息。