1# AbilityDelegator
2
3AbilityDelegator提供添加用于监视指定Ability的生命周期状态更改的[AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1)对象的能力,包括对AbilityMonitor实例的添加、删除、等待Ability到达OnCreate生命周期、设置等待时间等、获取指定Ability的生命周期状态、获取当前应用顶部Ability、启动指定Ability等。
4
5> **说明:**
6>
7> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8>
9> 本模块接口仅可在<!--RP1-->[自动化测试框架arkxtest](../../application-test/arkxtest-guidelines.md)<!--RP1End-->中使用。
10
11## 导入模块
12
13```ts
14import { abilityDelegatorRegistry } from '@kit.TestKit';
15```
16
17## 使用说明
18
19通过abilityDelegatorRegistry中getAbilityDelegator方法获取。
20```ts
21import { abilityDelegatorRegistry } from '@kit.TestKit';
22```
23
24## AbilityDelegator
25
26### addAbilityMonitor<sup>9+</sup>
27
28addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
29
30添加AbilityMonitor实例。使用callback异步回调。不支持多线程并发调用。
31
32**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
33
34**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
35
36**参数:**
37
38| 参数名   | 类型                                                         | 必填 | 说明                                                         |
39| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
40| monitor  | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1) | 是       | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1)实例。 |
41| callback | AsyncCallback\<void>                                         | 是       | 回调函数。当添加AbilityMonitor实例成功,err为undefined,否则为错误对象。   |
42
43**错误码**:
44
45以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
46
47| 错误码ID | 错误信息 |
48| ------- | -------- |
49| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
50| 16000100 | Calling AddAbilityMonitor failed. |
51
52**示例:**
53
54```ts
55import { abilityDelegatorRegistry } from '@kit.TestKit';
56import { UIAbility } from '@kit.AbilityKit';
57import { BusinessError } from '@kit.BasicServicesKit';
58
59let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
60let monitor: abilityDelegatorRegistry.AbilityMonitor = {
61  abilityName: 'abilityname',
62  onAbilityCreate: onAbilityCreateCallback
63};
64
65function onAbilityCreateCallback(data: UIAbility) {
66  console.info(`onAbilityCreateCallback, data: ${JSON.stringify(data)}`);
67}
68
69abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
70abilityDelegator.addAbilityMonitor(monitor, (error: BusinessError) => {
71  console.error(`addAbilityMonitor fail, error: ${JSON.stringify(error)}`);
72});
73```
74
75### addAbilityMonitor<sup>9+</sup>
76
77addAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
78
79添加AbilityMonitor实例。使用Promise异步回调。不支持多线程并发调用。
80
81**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
82
83**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
84
85**参数:**
86
87| 参数名  | 类型                                                         | 必填 | 说明                                                         |
88| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
89| monitor | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1) | 是   | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1)实例。 |
90
91**返回值:**
92
93| 类型           | 说明                |
94| -------------- | ------------------- |
95| Promise\<void> |Promise对象。无返回结果的Promise对象。 |
96
97**错误码**:
98
99以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
100
101| 错误码ID | 错误信息 |
102| ------- | -------- |
103| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
104| 16000100 | Calling AddAbilityMonitor failed. |
105
106**示例:**
107
108```ts
109import { abilityDelegatorRegistry } from '@kit.TestKit';
110import { UIAbility } from '@kit.AbilityKit';
111
112function onAbilityCreateCallback(data: UIAbility) {
113  console.info('onAbilityCreateCallback');
114}
115
116let monitor: abilityDelegatorRegistry.AbilityMonitor = {
117  abilityName: 'abilityname',
118  onAbilityCreate: onAbilityCreateCallback
119};
120let abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
121
122abilityDelegator.addAbilityMonitor(monitor).then(() => {
123  console.info('addAbilityMonitor promise');
124});
125```
126
127### addAbilityMonitorSync<sup>10+</sup>
128
129addAbilityMonitorSync(monitor: AbilityMonitor): void
130
131同步添加AbilityMonitor实例。不支持多线程并发调用。
132
133**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
134
135**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
136
137**参数:**
138
139| 参数名  | 类型                                                         | 必填 | 说明                                                         |
140| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
141| monitor | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1) | 是   | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1)实例。 |
142
143**错误码**:
144
145以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
146
147| 错误码ID | 错误信息 |
148| ------- | -------- |
149| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
150| 16000100 | Calling AddAbilityMonitorSync failed. |
151
152**示例:**
153
154```ts
155import { abilityDelegatorRegistry } from '@kit.TestKit';
156import { UIAbility } from '@kit.AbilityKit';
157
158let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
159
160function onAbilityCreateCallback(data: UIAbility) {
161  console.info('onAbilityCreateCallback');
162}
163
164let monitor: abilityDelegatorRegistry.AbilityMonitor = {
165  abilityName: 'abilityname',
166  onAbilityCreate: onAbilityCreateCallback
167};
168
169abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
170abilityDelegator.addAbilityMonitorSync(monitor);
171```
172
173### removeAbilityMonitor<sup>9+</sup>
174
175removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
176
177删除已经添加的AbilityMonitor实例。使用callback异步回调。
178
179**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
180
181**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
182
183**参数:**
184
185| 参数名   | 类型                                                         | 必填 | 说明                                                         |
186| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
187| monitor  | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1) | 是   | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1)实例。 |
188| callback | AsyncCallback\<void>                                         | 是   | 回调函数。当删除已经添加的AbilityMonitor实例成功,err为undefined,否则为错误对象。  |
189
190**错误码**:
191
192以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
193
194| 错误码ID | 错误信息 |
195| ------- | -------- |
196| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
197| 16000100 | Calling RemoveAbilityMonitor failed. |
198
199**示例:**
200
201```ts
202import { abilityDelegatorRegistry } from '@kit.TestKit';
203import { UIAbility } from '@kit.AbilityKit';
204import { BusinessError } from '@kit.BasicServicesKit';
205
206let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
207
208function onAbilityCreateCallback(data: UIAbility) {
209    console.info('onAbilityCreateCallback');
210}
211
212let monitor: abilityDelegatorRegistry.AbilityMonitor = {
213    abilityName: 'abilityname',
214    onAbilityCreate: onAbilityCreateCallback
215};
216
217abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
218abilityDelegator.removeAbilityMonitor(monitor, (error: BusinessError) => {
219    console.error(`removeAbilityMonitor fail, error: ${JSON.stringify(error)}`);
220});
221```
222
223### removeAbilityMonitor<sup>9+</sup>
224
225removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
226
227删除已经添加的AbilityMonitor实例。使用Promise异步回调。不支持多线程并发调用。
228
229**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
230
231**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
232
233**参数:**
234
235| 参数名    | 类型                                                         | 必填 | 说明                                                         |
236| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
237| monitor | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1) | 是   | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1)实例。 |
238
239**返回值:**
240
241| 类型           | 说明                |
242| -------------- | ------------------- |
243| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
244
245**错误码**:
246
247以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
248
249| 错误码ID | 错误信息 |
250| ------- | -------- |
251| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
252| 16000100 | Calling RemoveAbilityMonitor failed. |
253
254- 示例
255
256```ts
257import { abilityDelegatorRegistry } from '@kit.TestKit';
258import { UIAbility } from '@kit.AbilityKit';
259
260let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
261let monitor: abilityDelegatorRegistry.AbilityMonitor = {
262  abilityName: 'abilityname',
263  onAbilityCreate: onAbilityCreateCallback
264};
265
266function onAbilityCreateCallback(data: UIAbility) {
267  console.info('onAbilityCreateCallback');
268}
269
270abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
271abilityDelegator.removeAbilityMonitor(monitor).then(() => {
272  console.info('removeAbilityMonitor promise');
273});
274```
275
276### removeAbilityMonitorSync<sup>10+</sup>
277
278removeAbilityMonitorSync(monitor: AbilityMonitor): void
279
280同步删除已经添加的AbilityMonitor实例。不支持多线程并发调用。
281
282**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
283
284**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
285
286**参数:**
287
288| 参数名   | 类型                                                         | 必填 | 说明                                                         |
289| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
290| monitor  | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1) | 是   | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1)实例。 |
291
292**错误码**:
293
294以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
295
296| 错误码ID | 错误信息 |
297| ------- | -------- |
298| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
299| 16000100 | Calling RemoveAbilityMonitorSync failed. |
300
301**示例:**
302
303```ts
304import { abilityDelegatorRegistry } from '@kit.TestKit';
305import { UIAbility } from '@kit.AbilityKit';
306
307let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
308let monitor: abilityDelegatorRegistry.AbilityMonitor = {
309  abilityName: 'abilityname',
310  onAbilityCreate: onAbilityCreateCallback
311};
312
313function onAbilityCreateCallback(data: UIAbility) {
314  console.info('onAbilityCreateCallback');
315}
316
317abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
318abilityDelegator.removeAbilityMonitorSync(monitor);
319```
320
321### waitAbilityMonitor<sup>9+</sup>
322
323waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<UIAbility>): void
324
325等待与AbilityMonitor实例匹配的Ability到达OnCreate生命周期,并返回Ability实例。使用callback异步回调。不支持多线程并发调用。
326
327**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
328
329**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
330
331**参数:**
332
333| 参数名   | 类型                                                         | 必填 | 说明                                                         |
334| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
335| monitor  | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1) | 是   | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1)实例。 |
336| callback | AsyncCallback\<[UIAbility](../apis-ability-kit/js-apis-app-ability-uiAbility.md)> | 是   | 回调函数。当等待与AbilityMonitor实例匹配的Ability到达OnCreate生命周期成功,err为undefined,data为获取到的Ability实例,否则为错误对象。   |
337
338**错误码**:
339
340以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
341
342| 错误码ID | 错误信息 |
343| ------- | -------- |
344| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
345| 16000100 | Calling WaitAbilityMonitor failed. |
346
347**示例:**
348
349```ts
350import { abilityDelegatorRegistry } from '@kit.TestKit';
351import { UIAbility } from '@kit.AbilityKit';
352import { BusinessError } from '@kit.BasicServicesKit';
353
354let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
355let monitor: abilityDelegatorRegistry.AbilityMonitor = {
356  abilityName: 'abilityname',
357  onAbilityCreate: onAbilityCreateCallback
358};
359
360function onAbilityCreateCallback(data: UIAbility) {
361  console.info('onAbilityCreateCallback');
362}
363
364abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
365abilityDelegator.waitAbilityMonitor(monitor, (error: BusinessError, data: UIAbility) => {
366  if (error) {
367    console.error(`waitAbilityMonitor fail, error: ${JSON.stringify(error)}`);
368  } else {
369    console.log(`waitAbilityMonitor success, data: ${JSON.stringify(data)}`);
370  }
371});
372```
373
374### waitAbilityMonitor<sup>9+</sup>
375
376waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback\<UIAbility>): void
377
378设置等待时间,等待与AbilityMonitor实例匹配的Ability到达OnCreate生命周期,并返回Ability实例。使用callback异步回调。不支持多线程并发调用。
379
380**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
381
382**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
383
384**参数:**
385
386| 参数名   | 类型                                                         | 必填 | 说明                                                         |
387| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
388| monitor  | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1) | 是   | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1)实例。 |
389| timeout  | number                                                       | 是   | 最大等待时间,单位毫秒(ms)。                                 |
390| callback | AsyncCallback\<[UIAbility](../apis-ability-kit/js-apis-app-ability-uiAbility.md)> | 是   | 表示指定的回调方法。                                           |
391
392**错误码**:
393
394以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
395
396| 错误码ID | 错误信息 |
397| ------- | -------- |
398| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
399| 16000100 | Calling WaitAbilityMonitor failed. |
400
401**示例:**
402
403```ts
404import { abilityDelegatorRegistry } from '@kit.TestKit';
405import { UIAbility } from '@kit.AbilityKit';
406import { BusinessError } from '@kit.BasicServicesKit';
407
408let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
409let timeout = 100;
410let monitor: abilityDelegatorRegistry.AbilityMonitor = {
411  abilityName: 'abilityname',
412  onAbilityCreate: onAbilityCreateCallback
413};
414
415function onAbilityCreateCallback(data: UIAbility) {
416  console.info('onAbilityCreateCallback');
417}
418
419abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
420abilityDelegator.waitAbilityMonitor(monitor, timeout, (error: BusinessError, data: UIAbility) => {
421  if (error && error.code !== 0) {
422    console.error(`waitAbilityMonitor fail, error: ${JSON.stringify(error)}`);
423  } else {
424    console.log(`waitAbilityMonitor success, data: ${JSON.stringify(data)}`);
425  }
426});
427```
428
429
430
431### waitAbilityMonitor<sup>9+</sup>
432
433waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<UIAbility>
434
435设置等待时间,等待与AbilityMonitor实例匹配的Ability到达OnCreate生命周期,并返回Ability实例。使用Promise异步回调。不支持多线程并发调用。
436
437**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
438
439**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
440
441**参数:**
442
443| 参数名  | 类型                                                         | 必填 | 说明                                                         |
444| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
445| monitor | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1) | 是   | [AbilityMonitor](../apis-ability-kit/js-apis-inner-application-abilityMonitor.md#abilitymonitor-1)实例。 |
446| timeout | number                                                       | 否   | 最大等待时间,单位毫秒(ms)。                                 |
447
448**返回值:**
449
450| 类型                                                        | 说明                       |
451| ----------------------------------------------------------- | -------------------------- |
452| Promise\<[UIAbility](../apis-ability-kit/js-apis-app-ability-uiAbility.md)> | Promise对象,返回Ability实例。 |
453
454**错误码**:
455
456以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
457
458| 错误码ID | 错误信息 |
459| ------- | -------- |
460| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
461| 16000100 | Calling WaitAbilityMonitor failed. |
462
463**示例:**
464
465```ts
466import { abilityDelegatorRegistry } from '@kit.TestKit';
467import { UIAbility } from '@kit.AbilityKit';
468
469let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
470let monitor: abilityDelegatorRegistry.AbilityMonitor = {
471  abilityName: 'abilityname',
472  onAbilityCreate: onAbilityCreateCallback
473};
474
475function onAbilityCreateCallback(data: UIAbility) {
476  console.info('onAbilityCreateCallback');
477}
478
479abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
480abilityDelegator.waitAbilityMonitor(monitor).then((data: UIAbility) => {
481  console.info('waitAbilityMonitor promise');
482});
483```
484
485### getAppContext<sup>9+</sup>
486
487getAppContext(): Context
488
489获取应用Context。
490
491**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
492
493**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
494
495**返回值:**
496
497| 类型                                  | 说明                                        |
498| ------------------------------------- | ------------------------------------------- |
499| [Context](../apis-ability-kit/js-apis-inner-application-context.md) | 应用[Context](../apis-ability-kit/js-apis-inner-application-context.md)。 |
500
501**示例:**
502
503```ts
504import { abilityDelegatorRegistry } from '@kit.TestKit';
505
506let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
507
508abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
509
510let context = abilityDelegator.getAppContext();
511```
512
513### getAbilityState<sup>9+</sup>
514
515getAbilityState(ability: UIAbility): number
516
517获取指定ability的生命周期状态。
518
519**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
520
521**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
522
523**参数:**
524
525| 参数名  | 类型                                              | 必填 | 说明            |
526| ------- | ------------------------------------------------- | ---- | --------------- |
527| ability | [UIAbility](../apis-ability-kit/js-apis-app-ability-uiAbility.md) | 是   | 指定Ability对象。 |
528
529**返回值:**
530
531| 类型   | 说明                                                         |
532| ------ | ------------------------------------------------------------ |
533| number | 指定ability的生命周期状态。状态枚举值使用AbilityLifecycleState。 |
534
535**错误码**:
536
537以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)。
538
539| 错误码ID | 错误信息 |
540| ------- | -------- |
541| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
542
543**示例:**
544
545```ts
546import { abilityDelegatorRegistry } from '@kit.TestKit';
547import { UIAbility } from '@kit.AbilityKit';
548import { BusinessError } from '@kit.BasicServicesKit';
549
550let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
551let ability: UIAbility;
552
553abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
554abilityDelegator.getCurrentTopAbility((err: BusinessError, data: UIAbility) => {
555  console.info('getCurrentTopAbility callback');
556  ability = data;
557  let state = abilityDelegator.getAbilityState(ability);
558  console.info('getAbilityState ${state}');
559});
560```
561
562### getCurrentTopAbility<sup>9+</sup>
563
564getCurrentTopAbility(callback: AsyncCallback\<UIAbility>): void
565
566获取当前应用顶部Ability。使用callback异步回调。不支持Worker线程调用。
567
568**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
569
570**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
571
572**参数:**
573
574| 参数名   | 类型                                                         | 必填 | 说明               |
575| -------- | ------------------------------------------------------------ | ---- | ------------------ |
576| callback | AsyncCallback\<[UIAbility](../apis-ability-kit/js-apis-app-ability-uiAbility.md)> | 是   | 回调函数。当获取当前应用顶部Ability成功,err为undefined,data为获取到的Ability实例;否则为错误对象。 |
577
578**错误码**:
579
580以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
581
582| 错误码ID | 错误信息 |
583| ------- | -------- |
584| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
585| 16000100 | Calling GetCurrentTopAbility failed. |
586
587**示例:**
588
589```ts
590import { abilityDelegatorRegistry } from '@kit.TestKit';
591import { UIAbility } from '@kit.AbilityKit';
592import { BusinessError } from '@kit.BasicServicesKit';
593
594let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
595let ability: UIAbility;
596
597abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
598abilityDelegator.getCurrentTopAbility((err: BusinessError, data: UIAbility) => {
599  console.info('getCurrentTopAbility callback');
600  ability = data;
601});
602```
603
604### getCurrentTopAbility<sup>9+</sup>
605
606getCurrentTopAbility(): Promise\<UIAbility>
607
608获取当前应用顶部Ability。使用Promise异步回调。不支持Worker线程调用。
609
610**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
611
612**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
613
614**返回值:**
615
616| 类型                                                        | 说明                                   |
617| ----------------------------------------------------------- | -------------------------------------- |
618| Promise\<[UIAbility](../apis-ability-kit/js-apis-app-ability-uiAbility.md)> | Promise对象,返回前应用顶部Ability。 |
619
620**错误码**:
621
622以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
623
624| 错误码ID | 错误信息 |
625| ------- | -------- |
626| 16000100 | Calling GetCurrentTopAbility failed. |
627
628**示例:**
629
630```ts
631import { abilityDelegatorRegistry } from '@kit.TestKit';
632import { UIAbility } from '@kit.AbilityKit';
633
634let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
635let ability: UIAbility;
636
637abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
638abilityDelegator.getCurrentTopAbility().then((data: UIAbility) => {
639  console.info('getCurrentTopAbility promise');
640  ability = data;
641});
642```
643
644### startAbility<sup>9+</sup>
645
646startAbility(want: Want, callback: AsyncCallback\<void>): void
647
648启动指定Ability。使用callback异步回调。
649
650**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
651
652**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
653
654**参数:**
655
656| 参数名   | 类型                                   | 必填 | 说明               |
657| -------- | -------------------------------------- | ---- | ------------------ |
658| want     | [Want](../apis-ability-kit/js-apis-app-ability-want.md) | 是   | 启动Ability参数。    |
659| callback | AsyncCallback\<void>                   | 是   | 回调函数。当启动指定Ability成功,err为undefined,否则为错误对象。 |
660
661**错误码**:
662
663以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
664
665| 错误码ID | 错误信息 |
666| ------- | -------- |
667| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
668| 16000001 | The specified ability does not exist. |
669| 16000002 | Incorrect ability type. |
670| 16000004 | Failed to start the invisible ability. |
671| 16000005 | The specified process does not have the permission. |
672| 16000006 | Cross-user operations are not allowed. |
673| 16000008 | The crowdtesting application expires. |
674| 16000009 | An ability cannot be started or stopped in Wukong mode. |
675| 16000010 | The call with the continuation and prepare continuation flag is forbidden. |
676| 16000011 | The context does not exist. |
677| 16000012 | The application is controlled. |
678| 16000013 | The application is controlled by EDM. |
679| 16000050 | Internal error. |
680| 16000053 | The ability is not on the top of the UI. |
681| 16000055 | Installation-free timed out. |
682| 16200001 | The caller has been released. |
683
684**示例:**
685
686```ts
687import { abilityDelegatorRegistry } from '@kit.TestKit';
688import { Want } from '@kit.AbilityKit';
689import { BusinessError } from '@kit.BasicServicesKit';
690
691let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
692let want: Want = {
693  bundleName: 'bundleName',
694  abilityName: 'abilityName'
695};
696
697abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
698abilityDelegator.startAbility(want, (err: BusinessError, data: void) => {
699  console.info('startAbility callback');
700});
701```
702
703### startAbility<sup>9+</sup>
704
705startAbility(want: Want): Promise\<void>
706
707启动指定Ability。使用Promise异步回调。
708
709**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
710
711**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
712
713**参数:**
714
715| 参数名 | 类型                                   | 必填 | 说明            |
716| ------ | -------------------------------------- | ---- | --------------- |
717| want   | [Want](../apis-ability-kit/js-apis-app-ability-want.md) | 是   | 启动Ability参数。 |
718
719**返回值:**
720
721| 类型           | 说明                |
722| -------------- | ------------------- |
723| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
724
725**错误码**:
726
727以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
728
729| 错误码ID | 错误信息 |
730| ------- | -------- |
731| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
732| 16000001 | The specified ability does not exist. |
733| 16000002 | Incorrect ability type. |
734| 16000004 | Failed to start the invisible ability. |
735| 16000005 | The specified process does not have the permission. |
736| 16000006 | Cross-user operations are not allowed. |
737| 16000008 | The crowdtesting application expires. |
738| 16000009 | An ability cannot be started or stopped in Wukong mode. |
739| 16000010 | The call with the continuation and prepare continuation flag is forbidden. |
740| 16000011 | The context does not exist. |
741| 16000012 | The application is controlled. |
742| 16000013 | The application is controlled by EDM. |
743| 16000050 | Internal error. |
744| 16000053 | The ability is not on the top of the UI. |
745| 16000055 | Installation-free timed out. |
746| 16200001 | The caller has been released. |
747
748**示例:**
749
750```ts
751import { abilityDelegatorRegistry } from '@kit.TestKit';
752import { Want } from '@kit.AbilityKit';
753
754let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
755let want: Want = {
756  bundleName: 'bundleName',
757  abilityName: 'abilityName'
758};
759
760abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
761abilityDelegator.startAbility(want).then((data: void) => {
762  console.info('startAbility promise');
763});
764```
765
766### doAbilityForeground<sup>9+</sup>
767
768doAbilityForeground(ability: UIAbility, callback: AsyncCallback\<void>): void
769
770调度指定Ability生命周期状态到Foreground状态。使用callback异步回调。
771
772**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
773
774**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
775
776**参数:**
777
778| 参数名   | 类型                    | 必填 | 说明                                                    |
779| -------- | ----------------------- | ---- | ------------------------------------------------------- |
780| ability  | UIAbility               | 是   | 指定Ability对象。                                         |
781| callback | AsyncCallback\<void>    | 是   | 回调函数。当调度指定Ability生命周期状态到Foreground状态成功,err为undefined,否则为错误对象。  |
782
783**错误码**:
784
785以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
786
787| 错误码ID | 错误信息 |
788| ------- | -------- |
789| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
790| 16000100 | Calling DoAbilityForeground failed. |
791
792**示例:**
793
794```ts
795import { abilityDelegatorRegistry } from '@kit.TestKit';
796import { UIAbility } from '@kit.AbilityKit';
797import { BusinessError } from '@kit.BasicServicesKit';
798
799let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
800let ability: UIAbility;
801
802abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
803abilityDelegator.getCurrentTopAbility((err: BusinessError, data: UIAbility) => {
804  console.info('getCurrentTopAbility callback');
805  ability = data;
806  abilityDelegator.doAbilityForeground(ability, (err: BusinessError) => {
807    console.info("doAbilityForeground callback");
808  });
809});
810```
811
812### doAbilityForeground<sup>9+</sup>
813
814doAbilityForeground(ability: UIAbility): Promise\<void>
815
816调度指定Ability生命周期状态到Foreground状态。使用Promise异步回调。
817
818**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
819
820**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
821
822**参数:**
823
824| 参数名  | 类型    | 必填 | 说明            |
825| ------- | ------- | ---- | --------------- |
826| ability | UIAbility | 是   | 指定Ability对象。 |
827
828**返回值:**
829
830| 类型              | 说明                                                         |
831| ----------------- | ------------------------------------------------------------ |
832| Promise\<void> | Promise对象。无返回结果的Promise对象。         |
833
834**错误码**:
835
836以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
837
838| 错误码ID | 错误信息 |
839| ------- | -------- |
840| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
841| 16000100 | Calling DoAbilityForeground failed. |
842
843**示例:**
844
845```ts
846import { abilityDelegatorRegistry } from '@kit.TestKit';
847import { UIAbility } from '@kit.AbilityKit';
848import { BusinessError } from '@kit.BasicServicesKit';
849
850let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
851let ability: UIAbility;
852
853abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
854abilityDelegator.getCurrentTopAbility((err: BusinessError, data: UIAbility) => {
855  console.info('getCurrentTopAbility callback');
856  ability = data;
857  abilityDelegator.doAbilityForeground(ability).then(() => {
858    console.info("doAbilityForeground promise");
859  });
860});
861```
862
863### doAbilityBackground<sup>9+</sup>
864
865doAbilityBackground(ability: UIAbility, callback: AsyncCallback\<void>): void
866
867调度指定Ability生命周期状态到Background状态。使用callback异步回调。
868
869**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
870
871**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
872
873**参数:**
874
875| 参数名   | 类型                    | 必填 | 说明                                                    |
876| -------- | ----------------------- | ---- | ------------------------------------------------------- |
877| ability  | UIAbility                 | 是   | 指定Ability对象。                                         |
878| callback | AsyncCallback\<void> | 是   | 回调函数。当调度指定Ability生命周期状态到Background状态成功,err为undefined,否则为错误对象。  |
879
880**错误码**:
881
882以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
883
884| 错误码ID | 错误信息 |
885| ------- | -------- |
886| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
887| 16000100 | Calling DoAbilityBackground failed. |
888
889**示例:**
890
891```ts
892import { abilityDelegatorRegistry } from '@kit.TestKit';
893import { UIAbility } from '@kit.AbilityKit';
894import { BusinessError } from '@kit.BasicServicesKit';
895
896let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
897let ability: UIAbility;
898
899abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
900abilityDelegator.getCurrentTopAbility((err: BusinessError, data: UIAbility) => {
901  console.info('getCurrentTopAbility callback');
902  ability = data;
903  abilityDelegator.doAbilityBackground(ability, (err: BusinessError) => {
904    console.info("doAbilityBackground callback");
905  });
906});
907```
908
909### doAbilityBackground<sup>9+</sup>
910
911doAbilityBackground(ability: UIAbility): Promise\<void>
912
913调度指定Ability生命周期状态到Background状态。使用Promise异步回调。
914
915**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
916
917**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
918
919**参数:**
920
921| 参数名  | 类型    | 必填 | 说明            |
922| ------- | ------- | ---- | --------------- |
923| ability | UIAbility | 是   | 指定Ability对象。 |
924
925**返回值:**
926
927| 类型              | 说明                                                         |
928| ----------------- | ------------------------------------------------------------ |
929| Promise\<void> | Promise对象。无返回结果的Promise对象。                            |
930
931**错误码**:
932
933以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
934
935| 错误码ID | 错误信息 |
936| ------- | -------- |
937| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
938| 16000100 | Calling DoAbilityBackground failed. |
939
940**示例:**
941
942```ts
943import { abilityDelegatorRegistry } from '@kit.TestKit';
944import { UIAbility } from '@kit.AbilityKit';
945import { BusinessError } from '@kit.BasicServicesKit';
946
947let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
948let ability: UIAbility;
949
950abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
951abilityDelegator.getCurrentTopAbility((err: BusinessError, data: UIAbility) => {
952  console.info('getCurrentTopAbility callback');
953  ability = data;
954  abilityDelegator.doAbilityBackground(ability).then(() => {
955    console.info("doAbilityBackground promise");
956  });
957});
958```
959
960### printSync<sup>9+</sup>
961
962printSync(msg: string): void
963
964打印日志信息到单元测试终端控制台。
965
966**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
967
968**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
969
970**参数:**
971
972| 参数名 | 类型   | 必填 | 说明       |
973| ------ | ------ | ---- | ---------- |
974| msg    | string | 是   | 日志字符串。 |
975
976**错误码**:
977
978以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)。
979
980| 错误码ID | 错误信息 |
981| ------- | -------- |
982| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
983
984**示例:**
985
986```ts
987import { abilityDelegatorRegistry } from '@kit.TestKit';
988
989let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
990let msg = 'msg';
991
992abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
993abilityDelegator.printSync(msg);
994```
995
996### print
997
998print(msg: string, callback: AsyncCallback\<void>): void
999
1000打印日志信息到单元测试终端控制台。使用callback异步回调。
1001
1002**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1003
1004**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1005
1006**参数:**
1007
1008| 参数名   | 类型                 | 必填 | 说明               |
1009| -------- | -------------------- | ---- | ------------------ |
1010| msg      | string               | 是   | 日志字符串。         |
1011| callback | AsyncCallback\<void> | 是   | 回调函数。当打印日志信息到单元测试终端控制台成功,err为undefined,否则为错误对象。 |
1012
1013**示例:**
1014
1015```ts
1016import { abilityDelegatorRegistry } from '@kit.TestKit';
1017import { BusinessError } from '@kit.BasicServicesKit';
1018
1019let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1020let msg = 'msg';
1021
1022abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1023abilityDelegator.print(msg, (err: BusinessError) => {
1024  console.info('print callback');
1025});
1026```
1027
1028### print
1029
1030print(msg: string): Promise\<void>
1031
1032打印日志信息到单元测试终端控制台。使用Promise异步回调。
1033
1034**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1035
1036**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1037
1038**参数:**
1039
1040| 参数名 | 类型   | 必填 | 说明       |
1041| ------ | ------ | ---- | ---------- |
1042| msg    | string | 是   | 日志字符串。 |
1043
1044**返回值:**
1045
1046| 类型           | 说明                |
1047| -------------- | ------------------- |
1048| Promise\<void> |Promise对象。无返回结果的Promise对象。 |
1049
1050**示例:**
1051
1052```ts
1053import { abilityDelegatorRegistry } from '@kit.TestKit';
1054
1055let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1056let msg = 'msg';
1057
1058abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1059abilityDelegator.print(msg).then(() => {
1060  console.info('print promise');
1061});
1062```
1063
1064### executeShellCommand
1065
1066executeShellCommand(cmd: string, callback: AsyncCallback\<ShellCmdResult>): void
1067
1068执行指定的shell命令。使用callback异步回调。
1069
1070仅支持如下shell命令:aa, bm, cp, mkdir, rm, uinput, hilog, ppwd, echo, uitest, acm, hidumper, wukong, pkill, ps, pidof
1071
1072**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1073
1074**系统能力:** SystemCapability.Ability.AbilityRuntime.Core
1075
1076**参数:**
1077
1078| 参数名   | 类型                                                         | 必填 | 说明               |
1079| -------- | ------------------------------------------------------------ | ---- | ------------------ |
1080| cmd      | string                                                       | 是   | shell命令字符串。    |
1081| callback | AsyncCallback\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#shellcmdresult)> | 是   | 回调函数。当执行指定的shell命令成功,err为undefined,data为获取到的执行结果;否则为错误对象。 |
1082
1083**示例:**
1084
1085```ts
1086import { abilityDelegatorRegistry } from '@kit.TestKit';
1087import { BusinessError } from '@kit.BasicServicesKit';
1088
1089let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1090let cmd = 'cmd';
1091
1092abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1093abilityDelegator.executeShellCommand(cmd, (err: BusinessError, data: abilityDelegatorRegistry.ShellCmdResult) => {
1094  console.info('executeShellCommand callback');
1095});
1096```
1097
1098### executeShellCommand
1099
1100executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\<ShellCmdResult>): void
1101
1102指定超时时间,并执行指定的shell命令。使用callback异步回调。
1103
1104仅支持如下shell命令:aa, bm, cp, mkdir, rm, uinput, hilog, ppwd, echo, uitest, acm, hidumper, wukong, pkill, ps, pidof
1105
1106**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1107
1108**系统能力:** SystemCapability.Ability.AbilityRuntime.Core
1109
1110**参数:**
1111
1112| 参数名      | 类型                                                         | 必填 | 说明                          |
1113| ----------- | ------------------------------------------------------------ | ---- | ----------------------------- |
1114| cmd         | string                                                       | 是   | shell命令字符串。               |
1115| timeoutSecs | number                                                       | 是   | 设定命令超时时间,单位秒(s)。 |
1116| callback    | AsyncCallback\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#shellcmdresult)> | 是   | 回调函数。当执行指定的shell命令成功,err为undefined,data为获取到的执行结果;否则为错误对象。   |
1117
1118**示例:**
1119
1120```ts
1121import { abilityDelegatorRegistry } from '@kit.TestKit';
1122import { BusinessError } from '@kit.BasicServicesKit';
1123
1124let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1125let cmd = 'cmd';
1126let timeout = 100;
1127
1128abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1129abilityDelegator.executeShellCommand(cmd, timeout, (err: BusinessError, data: abilityDelegatorRegistry.ShellCmdResult) => {
1130  console.info('executeShellCommand callback');
1131});
1132```
1133
1134### executeShellCommand
1135
1136executeShellCommand(cmd: string, timeoutSecs?: number): Promise\<ShellCmdResult>
1137
1138指定超时时间,并执行指定的shell命令。使用Promise异步回调。
1139
1140仅支持如下shell命令:aa, bm, cp, mkdir, rm, uinput, hilog, ppwd, echo, uitest, acm, hidumper, wukong, pkill, ps, pidof
1141
1142**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1143
1144**系统能力:** SystemCapability.Ability.AbilityRuntime.Core
1145
1146**参数:**
1147
1148| 参数名      | 类型   | 必填 | 说明                          |
1149| ----------- | ------ | ---- | ----------------------------- |
1150| cmd         | string | 是   | shell命令字符串。               |
1151| timeoutSecs | number | 否   | 设定命令超时时间,单位秒(s)。 |
1152
1153**返回值:**
1154
1155| 类型                                                         | 说明                                                         |
1156| ------------------------------------------------------------ | ------------------------------------------------------------ |
1157| Promise\<[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#shellcmdresult)> | Promise对象,返回Shell命令执行结果[ShellCmdResult](js-apis-inner-application-shellCmdResult.md#shellcmdresult)对象。 |
1158
1159**示例:**
1160
1161```ts
1162import { abilityDelegatorRegistry } from '@kit.TestKit';
1163
1164let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1165let cmd = 'cmd';
1166let timeout = 100;
1167
1168abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1169abilityDelegator.executeShellCommand(cmd, timeout).then((data) => {
1170  console.info('executeShellCommand promise');
1171});
1172```
1173
1174### finishTest<sup>9+</sup>
1175
1176finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void
1177
1178结束测试并打印日志信息到单元测试终端控制台。使用callback异步回调。
1179
1180**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1181
1182**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1183
1184**参数:**
1185
1186| 参数名   | 类型                 | 必填 | 说明               |
1187| -------- | -------------------- | ---- | ------------------ |
1188| msg      | string               | 是   | 日志字符串。         |
1189| code     | number               | 是   | 日志码。             |
1190| callback | AsyncCallback\<void> | 是   | 回调函数。当结束测试并打印日志信息到单元测试终端控制台成功,err为undefined,否则为错误对象。 |
1191
1192**错误码**:
1193
1194以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1195
1196| 错误码ID | 错误信息 |
1197| ------- | -------- |
1198| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1199| 16000100 | Calling FinishTest failed. |
1200
1201**示例:**
1202
1203```ts
1204import { abilityDelegatorRegistry } from '@kit.TestKit';
1205import { BusinessError } from '@kit.BasicServicesKit';
1206
1207let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1208let msg = 'msg';
1209
1210abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1211abilityDelegator.finishTest(msg, 0, (err: BusinessError) => {
1212  console.info('finishTest callback');
1213});
1214```
1215
1216### finishTest<sup>9+</sup>
1217
1218finishTest(msg: string, code: number): Promise\<void>
1219
1220结束测试并打印日志信息到单元测试终端控制台。使用Promise异步回调。
1221
1222**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1223
1224**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1225
1226**参数:**
1227
1228| 参数名 | 类型   | 必填 | 说明       |
1229| ------ | ------ | ---- | ---------- |
1230| msg    | string | 是   | 日志字符串。 |
1231| code   | number | 是   | 日志码。     |
1232
1233**返回值:**
1234
1235| 类型           | 说明                |
1236| -------------- | ------------------- |
1237| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
1238
1239**错误码**:
1240
1241以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1242
1243| 错误码ID | 错误信息 |
1244| ------- | -------- |
1245| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1246| 16000100 | Calling FinishTest failed. |
1247
1248**示例:**
1249
1250```ts
1251import { abilityDelegatorRegistry } from '@kit.TestKit';
1252
1253let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1254let msg = 'msg';
1255
1256abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1257abilityDelegator.finishTest(msg, 0).then(() => {
1258  console.info('finishTest promise');
1259});
1260```
1261
1262### addAbilityStageMonitor<sup>9+</sup>
1263
1264addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<void>): void
1265
1266添加一个AbilityStageMonitor对象,用于监视指定AbilityStage的生命周期状态更改。使用callback异步回调。
1267
1268**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1269
1270**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1271
1272**参数:**
1273
1274| 参数名   | 类型                                                         | 必填 | 说明                                                         |
1275| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
1276| monitor  | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) | 是       | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) 实例。 |
1277| callback | AsyncCallback\<void>                                         | 是       | 回调函数。当添加一个用于监视指定AbilityStage的生命周期状态更改的AbilityStageMonitor对象成功,err为undefined,否则为错误对象。     |
1278
1279**错误码**:
1280
1281以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1282
1283| 错误码ID | 错误信息 |
1284| ------- | -------- |
1285| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1286| 16000100 | Calling AddAbilityStageMonitor failed. |
1287
1288**示例:**
1289
1290```ts
1291import { abilityDelegatorRegistry } from '@kit.TestKit';
1292import { BusinessError } from '@kit.BasicServicesKit';
1293
1294let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1295
1296abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1297abilityDelegator.addAbilityStageMonitor({
1298  moduleName: 'moduleName',
1299  srcEntrance: 'srcEntrance',
1300}, (err: BusinessError) => {
1301  console.info('addAbilityStageMonitor callback');
1302});
1303```
1304
1305### addAbilityStageMonitor<sup>9+</sup>
1306
1307addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>
1308
1309添加一个AbilityStageMonitor对象,用于监视指定AbilityStage的生命周期状态更改。使用Promise异步回调。
1310
1311**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1312
1313**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1314
1315**参数:**
1316
1317| 参数名  | 类型                                                         | 必填 | 说明                                                         |
1318| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
1319| monitor | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) | 是   | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) 实例。 |
1320
1321**返回值:**
1322
1323| 类型           | 说明                |
1324| -------------- | ------------------- |
1325| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
1326
1327**错误码**:
1328
1329以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1330
1331| 错误码ID | 错误信息 |
1332| ------- | -------- |
1333| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1334| 16000100 | Calling AddAbilityStageMonitor failed. |
1335
1336**示例:**
1337
1338```ts
1339import { abilityDelegatorRegistry } from '@kit.TestKit';
1340
1341let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1342
1343abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1344abilityDelegator.addAbilityStageMonitor({
1345  moduleName: 'moduleName',
1346  srcEntrance: 'srcEntrance',
1347}).then(() => {
1348  console.info('addAbilityStageMonitor promise');
1349});
1350```
1351
1352### addAbilityStageMonitorSync<sup>10+</sup>
1353
1354addAbilityStageMonitorSync(monitor: AbilityStageMonitor): void
1355
1356同步添加一个AbilityStageMonitor对象,用于监视指定AbilityStage的生命周期状态更改。
1357
1358**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1359
1360**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1361
1362**参数:**
1363
1364| 参数名   | 类型                                                         | 必填 | 说明                                                         |
1365| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
1366| monitor  | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) | 是       | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) 实例。 |
1367
1368**错误码**:
1369
1370以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1371
1372| 错误码ID | 错误信息 |
1373| ------- | -------- |
1374| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1375| 16000100 | Calling AddAbilityStageMonitorSync failed. |
1376
1377**示例:**
1378
1379```ts
1380import { abilityDelegatorRegistry } from '@kit.TestKit';
1381
1382let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1383
1384abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1385abilityDelegator.addAbilityStageMonitorSync({
1386  moduleName: 'moduleName',
1387  srcEntrance: 'srcEntrance',
1388});
1389```
1390
1391### removeAbilityStageMonitor<sup>9+</sup>
1392
1393removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<void>): void
1394
1395从应用程序内存中删除指定的AbilityStageMonitor对象。使用callback异步回调。
1396
1397**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1398
1399**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1400
1401**参数:**
1402
1403| 参数名   | 类型                                                         | 必填 | 说明                                                         |
1404| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
1405| monitor  | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) | 是       | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) 实例。 |
1406| callback | AsyncCallback\<void>                                         | 是       | 回调函数。当从应用程序内存中删除指定的AbilityStageMonitor对象成功,err为undefined,否则为错误对象。 |
1407
1408**错误码**:
1409
1410以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1411
1412| 错误码ID | 错误信息 |
1413| ------- | -------- |
1414| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1415| 16000100 | Calling RemoveAbilityStageMonitor failed. |
1416
1417**示例:**
1418
1419```ts
1420import { abilityDelegatorRegistry } from '@kit.TestKit';
1421import { BusinessError } from '@kit.BasicServicesKit';
1422
1423let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1424
1425abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1426abilityDelegator.removeAbilityStageMonitor({
1427  moduleName: 'moduleName',
1428  srcEntrance: 'srcEntrance',
1429}, (err: BusinessError) => {
1430  console.info('removeAbilityStageMonitor callback');
1431});
1432```
1433
1434### removeAbilityStageMonitor<sup>9+</sup>
1435
1436removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>
1437
1438从应用程序内存中删除指定的AbilityStageMonitor对象。使用Promise异步回调。
1439
1440**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1441
1442**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1443
1444**参数:**
1445
1446| 参数名  | 类型                                                         | 必填 | 说明                                                         |
1447| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
1448| monitor | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) | 是   | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) 实例。 |
1449
1450**返回值:**
1451
1452| 类型           | 说明                |
1453| -------------- | ------------------- |
1454| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
1455
1456**错误码**:
1457
1458以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1459
1460| 错误码ID | 错误信息 |
1461| ------- | -------- |
1462| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1463| 16000100 | Calling RemoveAbilityStageMonitor failed. |
1464
1465**示例:**
1466
1467```ts
1468import { abilityDelegatorRegistry } from '@kit.TestKit';
1469
1470let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1471
1472abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1473abilityDelegator.removeAbilityStageMonitor({
1474  moduleName: 'moduleName',
1475  srcEntrance: 'srcEntrance',
1476}).then(() => {
1477  console.info('removeAbilityStageMonitor promise');
1478});
1479```
1480
1481### removeAbilityStageMonitorSync<sup>10+</sup>
1482
1483removeAbilityStageMonitorSync(monitor: AbilityStageMonitor): void
1484
1485同步从应用程序内存中删除指定的AbilityStageMonitor对象。
1486
1487**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1488
1489**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1490
1491**参数:**
1492
1493| 参数名   | 类型                                                         | 必填 | 说明                                                         |
1494| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
1495| monitor  | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) | 是       | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) 实例。 |
1496
1497**错误码**:
1498
1499以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1500
1501| 错误码ID | 错误信息 |
1502| ------- | -------- |
1503| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1504| 16000100 | Calling RemoveAbilityStageMonitorSync failed. |
1505
1506
1507**示例:**
1508
1509```ts
1510import { abilityDelegatorRegistry } from '@kit.TestKit';
1511
1512let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1513
1514abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1515abilityDelegator.removeAbilityStageMonitorSync({
1516  moduleName: 'moduleName',
1517  srcEntrance: 'srcEntrance',
1518});
1519```
1520
1521### waitAbilityStageMonitor<sup>9+</sup>
1522
1523waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\<AbilityStage>): void
1524
1525等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象。使用callback异步回调。
1526
1527**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1528
1529**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1530
1531**参数:**
1532
1533| 参数名   | 类型                                                         | 必填 | 说明                                                         |
1534| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
1535| monitor  | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) | 是       | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) 实例。 |
1536| callback | AsyncCallback\<AbilityStage>                                         | 是       | 回调函数。当等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象的操作成功,err为undefined,data为获取到的[AbilityStage](../apis-ability-kit/js-apis-app-ability-abilityStage.md)对象;否则为错误对象。    |
1537
1538**错误码**:
1539
1540以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1541
1542| 错误码ID | 错误信息 |
1543| ------- | -------- |
1544| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1545| 16000100 | Calling WaitAbilityStageMonitor failed. |
1546
1547**示例:**
1548
1549```ts
1550import { abilityDelegatorRegistry } from '@kit.TestKit';
1551import { AbilityStage } from '@kit.AbilityKit';
1552import { BusinessError } from '@kit.BasicServicesKit';
1553
1554let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1555
1556abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1557abilityDelegator.waitAbilityStageMonitor({
1558  moduleName: 'moduleName',
1559  srcEntrance: 'srcEntrance',
1560}, (err: BusinessError, data: AbilityStage) => {
1561  console.info('waitAbilityStageMonitor callback');
1562});
1563```
1564
1565### waitAbilityStageMonitor<sup>9+</sup>
1566
1567waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise\<AbilityStage>
1568
1569等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象。使用Promise异步回调。
1570
1571**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1572
1573**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1574
1575**参数:**
1576
1577| 参数名  | 类型                                                         | 必填 | 说明                                                         |
1578| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
1579| monitor | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) | 是   | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) 实例。 |
1580| timeout | number | 否   | 超时最大等待时间,以毫秒为单位。 |
1581
1582**返回值:**
1583
1584| 类型           | 说明                |
1585| -------------- | ------------------- |
1586| Promise\<AbilityStage> | Promise对象,返回[AbilityStage](../apis-ability-kit/js-apis-app-ability-abilityStage.md)对象。 |
1587
1588**错误码**:
1589
1590以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1591
1592| 错误码ID | 错误信息 |
1593| ------- | -------- |
1594| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1595| 16000100 | Calling WaitAbilityStageMonitor failed. |
1596
1597**示例:**
1598
1599```ts
1600import { abilityDelegatorRegistry } from '@kit.TestKit';
1601import { AbilityStage } from '@kit.AbilityKit';
1602
1603let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1604
1605abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1606abilityDelegator.waitAbilityStageMonitor({
1607  moduleName: 'moduleName',
1608  srcEntrance: 'srcEntrance',
1609}).then((data: AbilityStage) => {
1610  console.info('waitAbilityStageMonitor promise');
1611});
1612```
1613
1614### waitAbilityStageMonitor<sup>9+</sup>
1615
1616waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback: AsyncCallback\<AbilityStage>): void
1617
1618等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象。使用callback异步回调。
1619
1620**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1621
1622**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1623
1624**参数:**
1625
1626| 参数名  | 类型                                                         | 必填 | 说明                                                         |
1627| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
1628| monitor | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) | 是   | [AbilityStageMonitor](../apis-ability-kit/js-apis-inner-application-abilityStageMonitor.md) 实例。 |
1629| timeout | number | 是   | 超时最大等待时间,以毫秒为单位。 |
1630| callback | AsyncCallback\<AbilityStage>                                         | 是       | 回调函数。当等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象的操作成功,err为undefined,data为获取到的[AbilityStage](../apis-ability-kit/js-apis-app-ability-abilityStage.md)对象;否则为错误对象。   |
1631
1632**错误码**:
1633
1634以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1635
1636| 错误码ID | 错误信息 |
1637| ------- | -------- |
1638| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1639| 16000100 | Calling WaitAbilityStageMonitor failed. |
1640
1641**示例:**
1642
1643```ts
1644import { abilityDelegatorRegistry } from '@kit.TestKit';
1645import { AbilityStage } from '@kit.AbilityKit';
1646import { BusinessError } from '@kit.BasicServicesKit';
1647
1648let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1649let timeout = 100;
1650
1651abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1652abilityDelegator.waitAbilityStageMonitor({
1653  moduleName: 'moduleName',
1654  srcEntrance: 'srcEntrance',
1655}, timeout, (err: BusinessError, data: AbilityStage) => {
1656  console.info('waitAbilityStageMonitor callback');
1657});
1658```
1659
1660### setMockList<sup>11+</sup>
1661
1662setMockList(mockList: Record\<string, string>): void
1663
1664设置模块的mock替换关系。
1665
1666**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
1667
1668**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
1669
1670**参数:**
1671
1672| 参数名   | 类型                      | 必填 | 说明                                                         |
1673| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
1674| mockList | Record\<string, string> | 是   | 模块mock替换关系的键值对象,其中key为待替换的目标路径,value为用于替换的mock实现文件的路径。 |
1675
1676**错误码:**
1677
1678以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](../apis-ability-kit/errorcode-ability.md)。
1679
1680| 错误码ID | 错误信息        |
1681| -------- | --------------- |
1682| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. |
1683| 16000050 | Internal error. |
1684
1685**示例:**
1686
1687```ts
1688import { abilityDelegatorRegistry } from '@kit.TestKit';
1689
1690let mockList: Record<string, string> = {
1691  '@ohos.router': 'src/main/mock/ohos/router.mock',
1692  'common.time': 'src/main/mock/common/time.mock',
1693};
1694let abilityDelegator: abilityDelegatorRegistry.AbilityDelegator;
1695
1696abilityDelegator = abilityDelegatorRegistry.getAbilityDelegator();
1697abilityDelegator.setMockList(mockList);
1698```
1699