@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 automated test scripts.

Modules to Import

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

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

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

Example

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

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

Example

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