HarmonyOS API:通用能力的接口
版本:v3.1 Beta
AppVersionInfo
更新时间: 2023-02-17 09:19
定义应用版本信息。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 类型 | 可读 | 可写 | 说明 |
appName | string | 是 | 否 | 模块名称。 |
versionCode | number | 是 | 否 | 模块描述信息。 |
versionName | string | 是 | 否 | 描述信息ID。 |
示例:
let appName;
let versionCode;
let versionName;
this.context.getAppVersionInfo((error, data) => {
console.info('getAppVersionInfo data is:' + JSON.stringify(data));
appName = data.appName;
versionCode = data.versionCode;
versionName = data.versionName;
});
ProcessInfo
更新时间: 2023-02-17 09:19
定义进程信息。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 类型 | 可读 | 可写 | 说明 |
pid | number | 是 | 否 | 进程ID。 |
processName | string | 是 | 否 | 进程名称。 |
示例:
import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext();
context.getProcessInfo((err, data) => {
console.info("getProcessInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
let pid = data.pid;
let processName = data.processName;
});
AbilityDelegatorArgs
更新时间: 2023-02-17 09:19
AbilityDelegatorArgs模块提供在应用程序启动期间,用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力。
说明
本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
使用说明
通过AbilityDelegatorRegistry中getArguments方法获取。
AbilityDelegatorArgs
测试参数信息
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 类型 | 可读 | 可写 | 说明 |
bundleName | string | 是 | 是 | 当前被测试应用的包名 |
parameters | {[key:string]: string} | 是 | 是 | 当前启动单元测试的参数 |
testCaseNames | string | 是 | 是 | 测试用例名称 |
testRunnerClassName | string | 是 | 是 | 执行测试用例的测试执行器的名称 |
示例:
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry';
var args = AbilityDelegatorRegistry.getArguments();
AbilityMonitor
更新时间: 2023-02-17 09:19
AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方法的能力,最近匹配的ability对象将保存在AbilityMonitor对象中。
说明
本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
使用说明
通过abilityDelegator中的addAbilityMonitor来设置。
AbilityMonitor
Ability监听器
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 类型 | 可读 | 可写 | 说明 |
abilityName | string | 是 | 是 | 当前AbilityMonitor绑定的ability名称 |
onAbilityCreate?:(data: UIAbility) | function | 是 | 是 | ability被启动初始化时的回调函数 不设置该属性则不能收到该生命周期回调 |
onAbilityForeground?:(data: UIAbility) | function | 是 | 是 | ability状态变成前台时的回调函数 不设置该属性则不能收到该生命周期回调 |
onAbilityBackground?:(data: UIAbility) | function | 是 | 是 | ability状态变成后台时的回调函数 不设置该属性则不能收到该生命周期回调 |
onAbilityDestroy?:(data: UIAbility) | function | 是 | 是 | ability被销毁前的回调函数 不设置该属性则不能收到该生命周期回调 |
onWindowStageCreate?:(data: UIAbility) | function | 是 | 是 | window stage被创建时的回调函数 不设置该属性则不能收到该生命周期回调 |
onWindowStageRestore?:(data: UIAbility) | function | 是 | 是 | window stage被重载时的回调函数 不设置该属性则不能收到该生命周期回调 |
onWindowStageDestroy?:(data: UIAbility) | function | 是 | 是 | window stage被销毁前的回调函数 不设置该属性则不能收到该生命周期回调 |
示例:
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
var abilityDelegator;
function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback");
}
var monitor = {
abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback
}
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor, (err : any) => {
console.info("addAbilityMonitor callback");
});
AbilityStageContext
更新时间: 2023-02-17 09:19
AbilityStageContext是AbilityStage的上下文环境,继承自Context。
AbilityStageContext提供允许访问特定于abilityStage的资源的能力,包括获取AbilityStage对应的ModuleInfo对象、环境变化对象。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。
使用说明
通过AbilityStage实例来获取。
import AbilityStage from '@ohos.app.ability.AbilityStage';
class MyAbilityStage extends AbilityStage {
onCreate() {
let abilityStageContext = this.context;
}
}
属性
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 类型 | 可读 | 可写 | 说明 |
currentHapModuleInfo | HapModuleInfo | 是 | 否 | AbilityStage对应的ModuleInfo对象。 |
config | 是 | 否 | 环境变化对象。 |
AbilityStageMonitor
更新时间: 2023-02-17 09:19
提供用于匹配满足指定条件的受监视的AbilityStage对象的方法。最近匹配的AbilityStage对象将保存在AbilityStageMonitor对象中。
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 类型 | 可读 | 可写 | 说明 |
moduleName9+ | string | 是 | 是 | 要监视的abilityStage的模块名。 |
srcEntrance9+ | string | 是 | 是 | 要监视的abilityStage的源路径。 |
示例:
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
let monitor = {
moduleName: "feature_as1",
srcEntrance: "./ets/Application/MyAbilityStage.ts",
};
let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityStageMonitor(monitor, (error, data) => {
console.info("stageMonitor waitAbilityStageMonitor, abilityStage = " + JSON.stringify(data));
});