HarmonyOS API:通用能力的接口
版本:v3.1 Beta
@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)
更新时间: 2023-02-17 09:19
AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力,包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'
AbilityLifecycleState
Ability生命周期状态。
系统能力 :以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
名称 | 值 | 说明 |
UNINITIALIZED | 0 | 表示无效状态。 |
CREATE | 1 | 表示Ability处于已创建状态。 |
FOREGROUND | 2 | 表示Ability处于前台状态。 |
BACKGROUND | 3 | 表示Ability处于后台状态。 |
DESTROY | 4 | 表示Ability处于已销毁状态。 |
AbilityDelegatorRegistry.getAbilityDelegator
getAbilityDelegator(): AbilityDelegator
获取应用程序的AbilityDelegator对象
系统能力: SystemCapability.Ability.AbilityRuntime.Core
返回值:
类型 | 说明 |
AbilityDelegator对象。可以用来调度测试框架相关功能。 |
示例:
var abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
AbilityDelegatorRegistry.getArguments
getArguments(): AbilityDelegatorArgs
获取单元测试参数AbilityDelegatorArgs对象
系统能力: SystemCapability.Ability.AbilityRuntime.Core
返回值:
类型 | 说明 |
AbilityDelegatorArgs对象。可以用来获取测试参数。 |
示例:
var args = AbilityDelegatorRegistry.getArguments();
console.info("getArguments bundleName:" + args.bundleName);
console.info("getArguments testCaseNames:" + args.testCaseNames);
console.info("getArguments testRunnerClassName:" + args.testRunnerClassName);
@ohos.app.ability.appManager (appManager)
更新时间: 2023-02-17 09:19
appManager模块提供App管理的能力,包括查询当前是否处于稳定性测试场景、查询是否为ram受限设备、获取应用程序的内存大小、获取有关运行进程的信息等。
说明
本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import appManager from '@ohos.app.ability.appManager';
appManager.isRunningInStabilityTest9+
static isRunningInStabilityTest(callback: AsyncCallback<boolean>): void
查询当前是否处于稳定性测试场景。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<boolean> | 是 | 返回当前是否处于稳定性测试场景。 |
示例:
import app from '@ohos.application.appManager';
app.isRunningInStabilityTest((err, flag) => {
console.log('startAbility result:' + JSON.stringify(err));
})
appManager.isRunningInStabilityTest9+
static isRunningInStabilityTest(): Promise<boolean>
查询当前是否处于稳定性测试场景。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
返回值:
类型 | 说明 |
Promise<boolean> | 返回当前是否处于稳定性测试场景。 |
示例:
import app from '@ohos.application.appManager';
app.isRunningInStabilityTest().then((flag) => {
console.log('success:' + JSON.stringify(flag));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
appManager.isRamConstrainedDevice
isRamConstrainedDevice(): Promise<boolean>;
查询是否为ram受限设备。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
返回值:
类型 | 说明 |
Promise<boolean> | 是否为ram受限设备。 |
示例:
app.isRamConstrainedDevice().then((data) => {
console.log('success:' + JSON.stringify(data));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
appManager.isRamConstrainedDevice
isRamConstrainedDevice(callback: AsyncCallback<boolean>): void;
查询是否为ram受限设备。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<boolean> | 是 | 返回当前是否是ram受限设备。 |
示例:
app.isRamConstrainedDevice((err, data) => {
console.log('startAbility result failed:' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data));
})
appManager.getAppMemorySize
getAppMemorySize(): Promise<number>;
获取应用程序的内存大小。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
返回值:
类型 | 说明 |
Promise<number> | 应用程序内存大小。 |
示例:
app.getAppMemorySize().then((data) => {
console.log('success:' + JSON.stringify(data));
}).catch((error) => {
console.log('failed:' + JSON.stringify(error));
});
appManager.getAppMemorySize
getAppMemorySize(callback: AsyncCallback<number>): void;
获取应用程序的内存大小。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
参数:
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<number> | 是 | 应用程序内存大小。 |
示例:
app.getAppMemorySize((err, data) => {
console.log('startAbility result failed :' + JSON.stringify(err));
console.log('startAbility result success:' + JSON.stringify(data));
})
@ohos.app.ability.Configuration (Configuration)
更新时间: 2023-03-03 17:21
定义环境变化信息。
说明
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import Configuration from '@ohos.app.ability.Configuration'
系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
名称 | 类型 | 可读 | 可写 | 说明 |
language | string | 是 | 是 | 表示应用程序的当前语言。 |
colorMode | 是 | 是 | 表示深浅色模式,取值范围:浅色模式(COLOR_MODE_LIGHT),深色模式(COLOR_MODE_DARK)。默认为浅色。 | |
direction | Direction | 是 | 否 | 表示屏幕方向,取值范围:水平方向(DIRECTION_HORIZONTAL),垂直方向(DIRECTION_VERTICAL)。 |
screenDensity | ScreenDensity | 是 | 否 | 表示屏幕分辨率,取值范围:SCREEN_DENSITY_SDPI(120)、SCREEN_DENSITY_MDPI(160)、SCREEN_DENSITY_LDPI(240)、SCREEN_DENSITY_XLDPI(320)、SCREEN_DENSITY_XXLDPI(480)、SCREEN_DENSITY_XXXLDPI(640)。 |
displayId | number | 是 | 否 | 表示应用所在的物理屏幕Id。 |
hasPointerDevice | boolean | 是 | 否 | 指示指针类型设备是否已连接,如键鼠、触控板等。 |
具体字段描述参考ohos.app.ability.Configuration.d.ts文件
示例:
import UIAbility from '@ohos.app.ability.UIAbility';
let envCallback = {
onConfigurationUpdated(config) {
console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`)
let language = config.language;
let colorMode = config.colorMode;
let direction = config.direction;
let screenDensity = config.screenDensity;
let displayId = config.displayId;
let hasPointerDevice = config.hasPointerDevice;
}
};
export default class MyAbility extends UIAbility {
onCreate() {
try {
var callbackId = this.context.getApplicationContext().on("environment", envCallback);
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
}
}