ApplicationContext模块提供开发者应用级别的的上下文的能力,包括提供注册及取消注册应用内组件生命周期的监听接口。
说明:
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。
导入模块
import common from '@ohos.app.ability.common';
使用说明
在使用ApplicationContext的功能前,需要通过context的实例获取。
ApplicationContext.on(type: 'abilityLifecycle', callback: AbilityLifecycleCallback)
on(type: 'abilityLifecycle', callback: AbilityLifecycleCallback): number;
注册监听应用内生命周期
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | 'abilityLifecycle' | 是 | 监听事件的类型。 |
callback | AbilityLifecycleCallback | 是 | 回调方法,返回注册监听事件的ID。 |
返回值:
类型 | 说明 |
---|---|
number | 返回的此次注册监听生命周期的ID(每次注册该ID会自增+1,当超过监听上限数量2^63-1时,返回-1)。 |
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
import AbilityLifecycleCallback from '@ohos.app.ability.AbilityLifecycleCallback';
let lifecycleId: number;
export default class EntryAbility extends UIAbility {
onCreate() {
console.log('MyAbility onCreate');
let AbilityLifecycleCallback: AbilityLifecycleCallback = {
onAbilityCreate(ability) {
console.log('AbilityLifecycleCallback onAbilityCreate ability: ${ability}');
},
onWindowStageCreate(ability, windowStage) {
console.log('AbilityLifecycleCallback onWindowStageCreate ability: ${ability}');
console.log('AbilityLifecycleCallback onWindowStageCreate windowStage: ${windowStage}');
},
onWindowStageActive(ability, windowStage) {
console.log('AbilityLifecycleCallback onWindowStageActive ability: ${ability}');
console.log('AbilityLifecycleCallback onWindowStageActive windowStage: ${windowStage}');
},
onWindowStageInactive(ability, windowStage) {
console.log('AbilityLifecycleCallback onWindowStageInactive ability: ${ability}');
console.log('AbilityLifecycleCallback onWindowStageInactive windowStage: ${windowStage}');
},
onWindowStageDestroy(ability, windowStage) {
console.log('AbilityLifecycleCallback onWindowStageDestroy ability: ${ability}');
console.log('AbilityLifecycleCallback onWindowStageDestroy windowStage: ${windowStage}');
},
onAbilityDestroy(ability) {
console.log('AbilityLifecycleCallback onAbilityDestroy ability: ${ability}');
},
onAbilityForeground(ability) {
console.log('AbilityLifecycleCallback onAbilityForeground ability: ${ability}');
},
onAbilityBackground(ability) {
console.log('AbilityLifecycleCallback onAbilityBackground ability: ${ability}');
},
onAbilityContinue(ability) {
console.log('AbilityLifecycleCallback onAbilityContinue ability: ${ability}');
}
}
// 1.通过context属性获取applicationContext
let applicationContext = this.context.getApplicationContext();
// 2.通过applicationContext注册监听应用内生命周期
lifecycleId = applicationContext.on('abilityLifecycle', AbilityLifecycleCallback);
console.log('registerAbilityLifecycleCallback lifecycleId: ${lifecycleId)}');
}
}
ApplicationContext.off(type: 'abilityLifecycle', callbackId: number, callback: AsyncCallback<void>)
off(type: 'abilityLifecycle', callbackId: number, callback: AsyncCallback<void>): void
取消监听应用内生命周期
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | 'abilityLifecycle' | 是 | 取消监听事件的类型。 |
callbackId | number | 是 | 注册监听应用内生命周期的ID。 |
callback | AsyncCallback<void> | 是 | 回调方法。 |
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
let lifecycleId: number;
export default class EntryAbility extends UIAbility {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
console.log('stage applicationContext: ${applicationContext}');
applicationContext.off('abilityLifecycle', lifecycleId, (error, data) => {
if (error) {
console.error('unregisterAbilityLifecycleCallback fail, err: ${JSON.stringify(error)}');
} else {
console.log('unregisterAbilityLifecycleCallback success, data: ${JSON.stringify(data)}');
}
});
}
}
ApplicationContext.off(type: 'abilityLifecycle', callbackId: number)
off(type: 'abilityLifecycle', callbackId: number): Promise<void>;
取消监听应用内生命周期
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | 'abilityLifecycle' | 是 | 取消监听事件的类型。 |
callbackId | number | 是 | 注册监听应用内生命周期的ID。 |
示例:
import Ability from '@ohos.app.ability.UIAbility';
let lifecycleId: number;
export default class MyAbility extends Ability {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
console.log('stage applicationContext: ${applicationContext}');
applicationContext.off('abilityLifecycle', lifecycleId);
}
}
ApplicationContext.on(type: 'environment', callback: EnvironmentCallback)
on(type: 'environment', callback: EnvironmentCallback): number;
注册对系统环境变化的监听。使用callback异步回调。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | 'environment' | 是 | 监听事件的类型。 |
callback | EnvironmentCallback | 是 | 回调方法,返回注册监听事件的ID。 |
返回值:
类型 | 说明 |
---|---|
number | 返回的此次注册监听系统环境变化的ID(每次注册该ID会自增+1,当超过监听上限数量2^63-1时,返回-1)。 |
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
import EnvironmentCallback from '@ohos.app.ability.EnvironmentCallback';
let callbackId: number;
export default class EntryAbility extends UIAbility {
onCreate() {
console.log('MyAbility onCreate')
let environmentCallback: EnvironmentCallback = {
onConfigurationUpdated(config){
console.log(`onConfigurationUpdated config: ${JSON.stringify(config)}`);
},
onMemoryLevel(level){
console.log('onMemoryLevel level: ${level}');
}
};
// 1.获取applicationContext
let applicationContext = this.context.getApplicationContext();
// 2.通过applicationContext注册监听系统环境变化
callbackId = applicationContext.on('environment', environmentCallback);
console.log(`registerEnvironmentCallback callbackId: ${callbackId}`);
}
}
ApplicationContext.off(type: 'environment', callbackId: number, callback: AsyncCallback<void>)
off(type: 'environment', callbackId: number, callback: AsyncCallback<void>): void
取消对系统环境变化的监听。使用callback异步回调。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | 'environment' | 是 | 取消监听事件的类型。 |
callbackId | number | 是 | 注册监听系统环境变化的ID。 |
callback | AsyncCallback<void> | 是 | 回调方法。 |
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
let callbackId: number;
export default class EntryAbility extends UIAbility {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.off('environment', callbackId, (error, data) => {
if (error) {
console.error('unregisterEnvironmentCallback fail, err: ${JSON.stringify(error)}');
} else {
console.log('unregisterEnvironmentCallback success, data: ${JSON.stringify(data)}');
}
});
}
}
ApplicationContext.off(type: 'environment', callbackId: number)
off(type: 'environment', callbackId: number): void;
取消对系统环境变化的监听。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | 'environment' | 是 | 取消监听事件的类型。 |
callbackId | number | 是 | 注册监听系统环境变化的ID。 |
callback | AsyncCallback<void> | 是 | 取消对系统环境变化监听的回调方法。 |
示例:
import Ability from '@ohos.app.ability.UIAbility';
let callbackId: number;
export default class MyAbility extends Ability {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.off('environment', callbackId);
}
}
ApplicationContext.on(type: 'applicationStateChange', callback: ApplicationStateChangeCallback)10+
on(type: 'applicationStateChange', callback: ApplicationStateChangeCallback): void
注册对当前应用前后台变化的监听。使用callback异步回调。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 监听事件类型,必须为'applicationStateChange'。 |
callback | ApplicationStateChangeCallback | 是 | 对于该事件监听的回调方法,可以对应用从后台切换到前台,以及前台切换到后台分别定义回调。 |
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
import ApplicationStateChangeCallback from '@ohos.app.ability.ApplicationStateChangeCallback';
export default class MyAbility extends UIAbility {
onCreate() {
console.log('MyAbility onCreate');
let applicationStateChangeCallback: ApplicationStateChangeCallback = {
onApplicationForeground() {
console.info('applicationStateChangeCallback onApplicationForeground');
},
onApplicationBackground() {
console.info('applicationStateChangeCallback onApplicationBackground');
}
}
// 1.获取applicationContext
let applicationContext = this.context.getApplicationContext();
// 2.通过applicationContext注册应用前后台状态监听
applicationContext.on('applicationStateChange', applicationStateChangeCallback);
console.log('Resgiter applicationStateChangeCallback');
}
}
ApplicationContext.off(type: 'applicationStateChange')10+
off(type: 'applicationStateChange', callback?: ApplicationStateChangeCallback): void
取消当前应用注册的前后台变化的全部监听。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 取消监听事件的类型,必须为'applicationStateChange'。 |
callback | ApplicationStateChangeCallback | 否 | 对于该事件监听的回调方法,可以对应用从后台切换到前台,以及前台切换到后台分别定义回调。 |
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
export default class MyAbility extends UIAbility {
onDestroy() {
let applicationContext = this.context.getApplicationContext();
applicationContext.off('applicationStateChange');
}
}
ApplicationContext.getRunningProcessInformation
getRunningProcessInformation(): Promise<Array<ProcessInformation>>;
获取有关运行进程的信息。以Promise形式返回。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
返回值:
类型 | 说明 |
---|---|
Promise<Array<ProcessInformation>> | 以Promise方式返回接口运行结果及有关运行进程的信息,可进行错误处理或其他自定义处理。 |
错误码:
错误码ID | 错误信息 |
---|---|
16000011 | The context does not exist. |
16000050 | Internal error. |
以上错误码详细介绍请参考元能力子系统错误码。
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';
export default class MyAbility extends UIAbility {
onForeground() {
let applicationContext = this.context.getApplicationContext();
applicationContext.getRunningProcessInformation().then((data) => {
console.log(`The process running information is: ${JSON.stringify(data)}`);
}).catch((error: BusinessError) => {
console.error(`error: ${JSON.stringify(error)}`);
});
}
}
ApplicationContext.getRunningProcessInformation
getRunningProcessInformation(callback: AsyncCallback<Array<ProcessInformation>>): void;
获取有关运行进程的信息。以Callback形式返回。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<Array<ProcessInformation>> | 是 | 获取有关运行进程的信息的回调。 |
错误码:
错误码ID | 错误信息 |
---|---|
16000011 | The context does not exist. |
16000050 | Internal error. |
以上错误码详细介绍请参考元能力子系统错误码。
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
export default class MyAbility extends UIAbility {
onForeground() {
let applicationContext = this.context.getApplicationContext();
applicationContext.getRunningProcessInformation((err, data) => {
if (err) {
console.error(`getRunningProcessInformation faile, err: ${JSON.stringify(err)}`);
} else {
console.log(`The process running information is: ${JSON.stringify(data)}`);
}
})
}
}
ApplicationContext.killAllProcesses
killAllProcesses(): Promise<void>;
杀死应用所在的进程。以Promise形式返回。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
返回值:
类型 | 说明 |
---|---|
Promise<void> | 以Promise方式返回杀死应用所在的进程结果。 |
错误码:
错误码ID | 错误信息 |
---|---|
16000011 | The context does not exist. |
以上错误码详细介绍请参考元能力子系统错误码。
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
export default class MyAbility extends UIAbility {
onBackground() {
let applicationContext = this.context.getApplicationContext();
applicationContext.killAllProcesses();
}
}
ApplicationContext.killAllProcesses
killAllProcesses(callback: AsyncCallback<void>): void
杀死应用所在的进程。以Callback形式返回。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<void> | 是 | 以callback方式返回杀死应用所在的进程结果。 |
错误码:
错误码ID | 错误信息 |
---|---|
16000011 | The context does not exist. |
以上错误码详细介绍请参考元能力子系统错误码。
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
export default class MyAbility extends UIAbility {
onBackground() {
let applicationContext = this.context.getApplicationContext();
applicationContext.killAllProcesses(error => {
if (error) {
console.error(`killAllProcesses fail, error: ${JSON.stringify(error)}`);
}
});
}
}
最后
有很多小伙伴不知道学习哪些鸿蒙开发技术?不知道需要重点掌握哪些鸿蒙应用开发知识点?而且学习时频繁踩坑,最终浪费大量时间。所以有一份实用的鸿蒙(HarmonyOS NEXT)资料用来跟着学习是非常有必要的。
这份鸿蒙(HarmonyOS NEXT)资料包含了鸿蒙开发必掌握的核心知识要点,内容包含了(ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、Harmony南向开发、鸿蒙项目实战等等)鸿蒙(HarmonyOS NEXT)技术知识点。
希望这一份鸿蒙学习资料能够给大家带来帮助,有需要的小伙伴自行领取,限时开源,先到先得~无套路领取!!
获取这份完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料
鸿蒙(HarmonyOS NEXT)最新学习路线
-
HarmonOS基础技能
- HarmonOS就业必备技能
- HarmonOS多媒体技术
- 鸿蒙NaPi组件进阶
- HarmonOS高级技能
- 初识HarmonOS内核
- 实战就业级设备开发
有了路线图,怎么能没有学习资料呢,小编也准备了一份联合鸿蒙官方发布笔记整理收纳的一套系统性的鸿蒙(OpenHarmony )学习手册(共计1236页)与鸿蒙(OpenHarmony )开发入门教学视频,内容包含:ArkTS、ArkUI、Web开发、应用模型、资源分类…等知识点。
获取以上完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料
《鸿蒙 (OpenHarmony)开发入门教学视频》
《鸿蒙生态应用开发V2.0白皮书》
《鸿蒙 (OpenHarmony)开发基础到实战手册》
OpenHarmony北向、南向开发环境搭建
《鸿蒙开发基础》
- ArkTS语言
- 安装DevEco Studio
- 运用你的第一个ArkTS应用
- ArkUI声明式UI开发
- .……
《鸿蒙开发进阶》
- Stage模型入门
- 网络管理
- 数据管理
- 电话服务
- 分布式应用开发
- 通知与窗口管理
- 多媒体技术
- 安全技能
- 任务管理
- WebGL
- 国际化开发
- 应用测试
- DFX面向未来设计
- 鸿蒙系统移植和裁剪定制
- ……
《鸿蒙进阶实战》
- ArkTS实践
- UIAbility应用
- 网络案例
- ……
获取以上完整鸿蒙HarmonyOS学习资料,请点击→纯血版全套鸿蒙HarmonyOS学习资料
总结
总的来说,华为鸿蒙不再兼容安卓,对中年程序员来说是一个挑战,也是一个机会。只有积极应对变化,不断学习和提升自己,他们才能在这个变革的时代中立于不败之地。