AbilityMonitor

本模块提供监听指定UIAbility生命周期状态变化的能力。开发者可以将AbilityMonitor作为abilityDelegator.addAbilityMonitor的入参来注册监听。

说明：

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

导入模块

import { abilityDelegatorRegistry } from '@kit.TestKit';

AbilityMonitor

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

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

名称	类型	只读	可选	说明
abilityName	string	否	否	被监听的UIAbility对象名称。
moduleName	string	否	是	被监听的UIAbility对象所属模块名称。
onAbilityCreate	(ability: UIAbility) => void	否	是	UIAbility对象被创建时，触发该回调函数。
onAbilityForeground	(ability: UIAbility) => void	否	是	UIAbility对象状态变成前台时，触发该回调函数。
onAbilityBackground	(ability: UIAbility) => void	否	是	UIAbility对象状态变成后台时，触发该回调函数。
onAbilityDestroy	(ability: UIAbility) => void	否	是	UIAbility对象被销毁前，触发该回调函数。
onWindowStageCreate	(ability: UIAbility) => void	否	是	当WindowStage实例被创建时，触发该回调函数。
onWindowStageRestore	(ability: UIAbility) => void	否	是	当UIAbility跨端迁移时，目标端UIAbility恢复页面栈时，触发该回调函数。
onWindowStageDestroy	(ability: UIAbility) => void	否	是	当WindowStage被销毁前，触发该回调函数。

示例：

import { abilityDelegatorRegistry } from '@kit.TestKit';
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

function onAbilityCreateCallback(data: UIAbility) {
  console.info(`onAbilityCreateCallback, data: ${JSON.stringify(data)}`);
}

let monitor: abilityDelegatorRegistry.AbilityMonitor = {
  abilityName: 'abilityname',
  moduleName: "moduleName",
  onAbilityCreate: onAbilityCreateCallback
}

let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor, (error: BusinessError) => {
  if (error) {
    console.error(`addAbilityMonitor fail, error: ${JSON.stringify(error)}`);
  }
});