• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)
2
3AbilityDelegatorRegistry是[自动化测试框架使用指南](../../application-test/arkxtest-guidelines.md)模块，该模块用于获取[AbilityDelegator](js-apis-inner-application-abilityDelegator.md)和[AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)对象，其中[AbilityDelegator](js-apis-inner-application-abilityDelegator.md)对象提供添加用于监视指定ability的生命周期状态更改的AbilityMonitor对象的能力，[AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)对象提供获取当前测试参数的能力。
4
5> **说明：**
6>
7> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8> 本模块接口仅可在测试框架中使用。
9
10## 导入模块
11
12```ts
13import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
14```
15
16## AbilityLifecycleState
17
18Ability生命周期状态，该类型为枚举，可配合[AbilityDelegator](js-apis-inner-application-abilityDelegator.md)的[getAbilityState(ability)](js-apis-inner-application-abilityDelegator.md#getabilitystate9)方法返回不同ability生命周期。
19
20**系统能力** ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
21
22| 名称          | 值   | 说明                        |
23| ------------- | ---- | --------------------------- |
24| UNINITIALIZED | 0    | 表示Ability处于无效状态。   |
25| CREATE        | 1    | 表示Ability处于已创建状态。 |
26| FOREGROUND    | 2    | 表示Ability处于前台状态。   |
27| BACKGROUND    | 3    | 表示Ability处于后台状态。   |
28| DESTROY       | 4    | 表示Ability处于已销毁状态。 |
29
30## AbilityDelegatorRegistry.getAbilityDelegator
31
32getAbilityDelegator(): AbilityDelegator
33
34获取应用程序的[AbilityDelegator](js-apis-inner-application-abilityDelegator.md)对象，该对象能够使用调度测试框架的相关功能。
35
36**系统能力：** SystemCapability.Ability.AbilityRuntime.Core
37
38**返回值：**
39
40| 类型                                                         | 说明                                                         |
41| ------------------------------------------------------------ | ------------------------------------------------------------ |
42| [AbilityDelegator](js-apis-inner-application-abilityDelegator.md#AbilityDelegator) | [AbilityDelegator](js-apis-inner-application-abilityDelegator.md#AbilityDelegator)对象。可以用来调度测试框架相关功能。 |
43
44**示例：**
45
46```ts
47import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
48import Want from '@ohos.app.ability.Want';
49
50let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
51
52let want: Want = {
53    bundleName: 'com.example.myapplication',
54    abilityName: 'EntryAbility'
55};
56abilityDelegator.startAbility(want, (err) => {
57    if (err) {
58        console.error(`Failed start ability, error: ${JSON.stringify(err)}`);
59    } else {
60        console.log('Success start ability.');
61    }
62});
63```
64
65## AbilityDelegatorRegistry.getArguments
66
67getArguments(): AbilityDelegatorArgs
68
69获取单元测试参数[AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)对象。
70
71**系统能力：** SystemCapability.Ability.AbilityRuntime.Core
72
73**返回值：**
74
75| 类型                                                         | 说明                                                         |
76| ------------------------------------------------------------ | ------------------------------------------------------------ |
77| [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md) | [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)对象。可以用来获取测试参数。 |
78
79**示例：**
80
81```ts
82import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
83
84let args = AbilityDelegatorRegistry.getArguments();
85console.info(`getArguments bundleName: ${args.bundleName}`);
86console.info(`getArguments parameters: ${JSON.stringify(args.parameters)}`);
87console.info(`getArguments testCaseNames: ${args.testCaseNames}`);
88console.info(`getArguments testRunnerClassName: ${args.testRunnerClassName}`);
89```
90