@ohos.app.ability.abilityLifecycleCallback (AbilityLifecycleCallback)


@ohos.app.ability.abilityLifecycleCallback (AbilityLifecycleCallback)

AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期发生变化时触发相应回调的能力,包括onAbilityCreateonWindowStageCreateonWindowStageActiveonWindowStageInactiveonWindowStageDestroyonAbilityDestroyonAbilityForegroundonAbilityBackgroundonAbilityContinue方法。

说明:

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

导入模块

import AbilityLifecycleCallback from "@ohos.app.ability.AbilityLifecycleCallback";
1

AbilityLifecycleCallback.onAbilityCreate

onAbilityCreate(ability: UIAbility): void;

注册监听应用上下文的生命周期后,在ability创建时触发回调。

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

参数:

参数名 类型 必填 说明
ability UIAbility 当前Ability对象

AbilityLifecycleCallback.onWindowStageCreate

onWindowStageCreate(ability: UIAbility, windowStage: window.WindowStage): void;

注册监听应用上下文的生命周期后,在windowStage创建时触发回调。

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

参数:

参数名 类型 必填 说明
ability UIAbility 当前Ability对象
windowStage window.WindowStage 当前WindowStage对象

AbilityLifecycleCallback.onWindowStageActive

onWindowStageActive(ability: UIAbility, windowStage: window.WindowStage): void;

注册监听应用上下文的生命周期后,在windowStage获焦时触发回调。

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

参数:

参数名 类型 必填 说明
ability UIAbility 当前Ability对象
windowStage window.WindowStage 当前WindowStage对象

AbilityLifecycleCallback.onWindowStageInactive

onWindowStageInactive(ability: UIAbility, windowStage: window.WindowStage): void;

注册监听应用上下文的生命周期后,在windowStage失焦时触发回调。

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

参数:

参数名 类型 必填 说明
ability UIAbility 当前Ability对象
windowStage window.WindowStage 当前WindowStage对象

AbilityLifecycleCallback.onWindowStageDestroy

onWindowStageDestroy(ability: UIAbility, windowStage: window.WindowStage): void;

注册监听应用上下文的生命周期后,在windowStage销毁时触发回调。

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

参数:

参数名 类型 必填 说明
ability UIAbility 当前Ability对象
windowStage window.WindowStage 当前WindowStage对象

AbilityLifecycleCallback.onAbilityDestroy

onAbilityDestroy(ability: UIAbility): void;

注册监听应用上下文的生命周期后,在ability销毁时触发回调。

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

参数:

参数名 类型 必填 说明
ability UIAbility 当前Ability对象

AbilityLifecycleCallback.onAbilityForeground

onAbilityForeground(ability: UIAbility): void;

注册监听应用上下文的生命周期后,在ability的状态从后台转到前台时触发回调。

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

参数:

参数名 类型 必填 说明
ability UIAbility 当前Ability对象

AbilityLifecycleCallback.onAbilityBackground

onAbilityBackground(ability: UIAbility): void;

注册监听应用上下文的生命周期后,在ability的状态从前台转到后台时触发回调。

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

参数:

参数名 类型 必填 说明
ability UIAbility 当前Ability对象

AbilityLifecycleCallback.onAbilityContinue

onAbilityContinue(ability: UIAbility): void;

注册监听应用上下文的生命周期后,在ability迁移时触发回调。

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

参数:

参数名 类型 必填 说明
ability UIAbility 当前Ability对象

示例:

MyAbilityStage.ts

import AbilityLifecycleCallback from "@ohos.app.ability.AbilityLifecycleCallback";
import AbilityStage from "@ohos.app.ability.AbilityStage"

// 声明ability生命周期回调
let abilityLifecycleCallback  =  {
    onAbilityCreate(ability){
        console.log("AbilityLifecycleCallback onAbilityCreate.");        
    },
    onWindowStageCreate(ability, windowStage){
        console.log("AbilityLifecycleCallback onWindowStageCreate.");          
    },
    onWindowStageActive(ability, windowStage){
        console.log("AbilityLifecycleCallback onWindowStageActive.");          
    },
    onWindowStageInactive(ability, windowStage){
        console.log("AbilityLifecycleCallback onWindowStageInactive.");
    },
    onWindowStageDestroy(ability, windowStage){
        console.log("AbilityLifecycleCallback onWindowStageDestroy."); 
    },
    onAbilityDestroy(ability){
        console.log("AbilityLifecycleCallback onAbilityDestroy.");             
    },
    onAbilityForeground(ability){
        console.log("AbilityLifecycleCallback onAbilityForeground.");             
    },
    onAbilityBackground(ability){
        console.log("AbilityLifecycleCallback onAbilityBackground.");              
    },
    onAbilityContinue(ability){
        console.log("AbilityLifecycleCallback onAbilityContinue.");
    }
}

export default class MyAbilityStage extends AbilityStage {
    onCreate() {
        console.log("MyAbilityStage onCreate");
        // 1.通过context属性获取applicationContext
        let applicationContext = this.context.getApplicationContext();
        // 2.通过applicationContext注册监听应用内生命周期
        try {
            globalThis.lifecycleId = applicationContext.on("abilityLifecycle", abilityLifecycleCallback);
            console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleId));
        } catch (paramError) {
            console.log("error: " + paramError.code + " ," + paramError.message);
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

MyAbility.ts

import UIAbility from "ohos.app.ability.UIAbility"

export default class MyAbility extends UIAbility {
    onDestroy() {
        let applicationContext = this.context.getApplicationContext();
        // 3.通过applicationContext注销监听应用内生命周期
        applicationContext.off("abilityLifecycle", globalThis.lifecycleId, (error) => {
            if (error.code != 0) {
                console.log("unregisterAbilityLifecycleCallback failed, error: " + JSON.stringify(error));
            } else {
                console.log("unregisterAbilityLifecycleCallback success.");
            }
        });
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15