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

  • 2025-06-12
  • 浏览 (4)

@ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)

AbilityDelegatorRegistry, a module of the automatic test framework, is used to obtain AbilityDelegator and AbilityDelegatorArgs objects. AbilityDelegator provides APIs for creating AbilityMonitor objects, which can be used to listen for ability lifecycle changes. AbilityDelegatorArgs provides APIs for obtaining test parameters.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs of this module can be used only in arkxtest.

Modules to Import

import { abilityDelegatorRegistry } from '@kit.TestKit';

AbilityLifecycleState

Enumerates the ability lifecycle states. It can be used in getAbilityState(ability) of AbilityDelegator to return different ability lifecycle states.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name Value Description
UNINITIALIZED 0 The ability is in an invalid state.
CREATE 1 The ability is created.
FOREGROUND 2 The ability is running in the foreground.
BACKGROUND 3 The ability is running in the background.
DESTROY 4 The ability is destroyed.

abilityDelegatorRegistry.getAbilityDelegator

getAbilityDelegator(): AbilityDelegator

Obtains an AbilityDelegator object.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type Description
AbilityDelegator AbilityDelegator object, which can be used to schedule the functionalities of the test framework.

Example

import { abilityDelegatorRegistry } from '@kit.TestKit';
import { Want } from '@kit.AbilityKit';

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

Obtains an AbilityDelegatorArgs object.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type Description
AbilityDelegatorArgs AbilityDelegatorArgs object, which can be used to obtain test parameters.

Example

import { abilityDelegatorRegistry } from '@kit.TestKit';

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}`);

AbilityDelegator

type AbilityDelegator = _AbilityDelegator

Represents the AbilityDelegator module.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Type Description
_AbilityDelegator The AbilityDelegator module.

AbilityDelegatorArgs

type AbilityDelegatorArgs = _AbilityDelegatorArgs

Represents the AbilityDelegatorArgs module.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Type Description
_AbilityDelegatorArgs The AbilityDelegatorArgs module.

AbilityMonitor

type AbilityMonitor = _AbilityMonitor

Represents the AbilityMonitor module.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Type Description
_AbilityMonitor The AbilityMonitor module.

ShellCmdResult

type ShellCmdResult = _ShellCmdResult

Represents the ShellCmdResult module.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Type Description
_ShellCmdResult The ShellCmdResult module.

AbilityStageMonitor14+

type AbilityStageMonitor = _AbilityStageMonitor

Represents the AbilityStageMonitor module.

Atomic service API: This API can be used in atomic services since API version 14.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Type Description
_AbilityStageMonitor The AbilityStageMonitor module.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Test Kit

harmony 鸿蒙UiTest Error Codes

harmony 鸿蒙@ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry)

harmony 鸿蒙@ohos.application.testRunner (TestRunner)

harmony 鸿蒙AbilityDelegator

harmony 鸿蒙AbilityDelegatorArgs

harmony 鸿蒙ShellCmdResult

harmony 鸿蒙js-apis-uitest

0  赞