harmony 鸿蒙@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)

2022-12-13
浏览 (685)

@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)

AbilityDelegatorRegistry是自动化测试框架使用指南模块，该模块用于获取AbilityDelegator和AbilityDelegatorArgs对象，其中AbilityDelegator对象提供添加用于监视指定ability的生命周期状态更改的AbilityMonitor对象的能力，AbilityDelegatorArgs对象提供获取当前测试参数的能力。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。本模块接口仅可在测试框架中使用。

导入模块

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';

AbilityLifecycleState

Ability生命周期状态，该类型为枚举，可配合AbilityDelegator的getAbilityState(ability)方法返回不同ability生命周期。

系统能力 ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

名称	值	说明
UNINITIALIZED	0	表示Ability处于无效状态。
CREATE	1	表示Ability处于已创建状态。
FOREGROUND	2	表示Ability处于前台状态。
BACKGROUND	3	表示Ability处于后台状态。
DESTROY	4	表示Ability处于已销毁状态。

AbilityDelegatorRegistry.getAbilityDelegator

getAbilityDelegator(): AbilityDelegator

获取应用程序的AbilityDelegator对象，该对象能够使用调度测试框架的相关功能。

系统能力： SystemCapability.Ability.AbilityRuntime.Core

返回值：

类型	说明
AbilityDelegator	AbilityDelegator对象。可以用来调度测试框架相关功能。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import Want from '@ohos.app.ability.Want';

let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();

let want: Want = {
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
};
abilityDelegator.startAbility(want, (err) => {
    if (err) {
        console.error(`Failed start ability, error: ${JSON.stringify(err)}`);
    } else {
        console.log('Success start ability.');
    }
});

AbilityDelegatorRegistry.getArguments

getArguments(): AbilityDelegatorArgs

获取单元测试参数AbilityDelegatorArgs对象。

系统能力： SystemCapability.Ability.AbilityRuntime.Core

返回值：

类型	说明
AbilityDelegatorArgs	AbilityDelegatorArgs对象。可以用来获取测试参数。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';

let args = AbilityDelegatorRegistry.getArguments();
console.info(`getArguments bundleName: ${args.bundleName}`);
console.info(`getArguments parameters: ${JSON.stringify(args.parameters)}`);
console.info(`getArguments testCaseNames: ${args.testCaseNames}`);
console.info(`getArguments testRunnerClassName: ${args.testRunnerClassName}`);