HarmonyOS API:Stage模型能力的接口
版本:v3.1 Beta
@ohos.app.ability.common (应用上下文Context)
更新时间: 2023-02-17 09:19
Common模块将二级模块API组织在一起方便开发者进行导出。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。
导入模块
import common from '@ohos.app.ability.common'
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
名称 | 类型 | 必填 | 说明 |
UIAbilityContext | 否 | UIAbilityContext二级模块。 | |
AbilityStageContext | 否 | AbilityStageContext二级模块。 | |
ApplicationContext | 否 | ApplicationContext二级模块。 | |
BaseContext | 否 | BaseContext二级模块。 | |
Context | 否 | Context二级模块。 | |
ExtensionContext | 否 | ExtensionContext二级模块。 | |
AreaMode | 否 | AreaMode枚举值。 | |
EventHub | 否 | EventHub二级模块。 | |
PacMap | PacMap | 否 | PacMap二级模块。 |
AbilityResult | 否 | AbilityResult二级模块。 | |
ConnectOptions | 否 | ConnectOptions二级模块。 |
示例:
import common from '@ohos.app.ability.common'
let uiAbilityContext: common.UIAbilityContext;
let abilityStageContext: common.AbilityStageContext;
let applicationContext: common.ApplicationContext;
let baseContext: common.BaseContext;
let context: common.Context;
let extensionContext: common.ExtensionContext;
let formExtensionContext: common.FormExtensionContext;
let areaMode: common.AreaMode;
let eventHub: common.EventHub;
let pacMap: common.PacMap;
let abilityResult: common.AbilityResult;
let connectOptions: common.ConnectOptions;
AreaMode
访问的文件分区,每个文件分区有对应自己的内容。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 值 | 说明 |
EL1 | 0 | 设备级加密区。 |
EL2 | 1 | 用户凭据加密区。默认为EL2。 |
@ohos.app.ability.contextConstant (ContextConstant)
更新时间: 2023-02-17 09:19
ContextConstant模块提供数据加密等级定义的能力。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。
导入模块
import contextConstant from '@ohos.app.ability.contextConstant';
ContextConstant.AreaMode
使用时通过ContextConstant.AreaMode获取。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 值 | 说明 |
EL1 | 0 | 设备级加密区。 |
EL2 | 1 | 用户凭据加密区。 |
@ohos.app.ability.EnvironmentCallback (EnvironmentCallback)
更新时间: 2023-02-17 09:19
EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境变化监听回调的能力,包括onConfigurationUpdated方法。
说明
本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。
导入模块
import EnvironmentCallback from "@ohos.app.ability.EnvironmentCallback";
EnvironmentCallback.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
注册系统环境变化的监听后,在系统环境变化时触发回调。
系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore
参数:
参数名 | 类型 | 必填 | 说明 |
config | 是 | 变化后的Configuration对象。 |
示例:
import Ability from "@ohos.app.ability.UIAbility";
var callbackId;
export default class MyAbility extends Ability {
onCreate() {
console.log("MyAbility onCreate")
globalThis.applicationContext = this.context.getApplicationContext();
let EnvironmentCallback = {
onConfigurationUpdated(config){
console.log("onConfigurationUpdated config:" + JSON.stringify(config));
},
}
// 1.获取applicationContext
let applicationContext = globalThis.applicationContext;
// 2.通过applicationContext注册监听应用内生命周期
callbackId = applicationContext.registerEnvironmentCallback(EnvironmentCallback);
console.log("registerEnvironmentCallback number: " + JSON.stringify(callbackId));
}
onDestroy() {
let applicationContext = globalThis.applicationContext;
applicationContext.unregisterEnvironmentCallback(callbackId, (error, data) => {
console.log("unregisterEnvironmentCallback success, err: " + JSON.stringify(error));
});
}
}
@ohos.app.ability.ExtensionAbility (扩展能力基类)
更新时间: 2023-02-17 09:19
ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力,包括ExtensionAbility创建、销毁、转储客户端信息等。
说明
本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。
导入模块
import ExtensionAbility from '@ohos.app.ability.ExtensionAbility';
系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore
示例:
class MyExtensionAbility extends ExtensionAbility {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
}
onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level));
}
}