harmony 鸿蒙AbilityDelegator

2022-12-13
浏览 (662)

AbilityDelegator

AbilityDelegator提供添加用于监视指定ability的生命周期状态更改的AbilityMonitor对象的能力，包括对AbilityMonitor实例的添加、删除、等待ability到达OnCreate生命周期、设置等待时间等、获取指定ability的生命周期状态、获取当前应用顶部ability、启动指定ability等。

说明：

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

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

使用说明

通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。此接口只能在测试环境下使用。

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

AbilityDelegator

addAbilityMonitor⁹⁺

addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback<void>): void;

添加AbilityMonitor实例（callback形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityMonitor	是	AbilityMonitor实例
callback	AsyncCallback<void>	是	表示指定的回调方法

错误码：

错误码ID	错误信息
16000100	AddAbilityMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

function onAbilityCreateCallback(data: UIAbility) {
    console.info(`onAbilityCreateCallback, data: ${JSON.stringify(data)}`);
}

let monitor: AbilityDelegatorRegistry.AbilityMonitor = {
    abilityName: 'abilityname',
    onAbilityCreate: onAbilityCreateCallback
};
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor, (error: BusinessError) => {
    console.error(`addAbilityMonitor fail, error: ${JSON.stringify(error)}`);
});

addAbilityMonitor⁹⁺

addAbilityMonitor(monitor: AbilityMonitor): Promise<void>;

添加AbilityMonitor实例（promise形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityMonitor	是	AbilityMonitor实例

返回值：

类型	说明
Promise<void>	以Promise形式返回。

错误码：

错误码ID	错误信息
16000100	AddAbilityMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

function onAbilityCreateCallback(data: UIAbility) {
    console.info('onAbilityCreateCallback');
}

let monitor: AbilityDelegatorRegistry.AbilityMonitor = {
    abilityName: 'abilityname',
    onAbilityCreate: onAbilityCreateCallback
};
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor).then(() => {
    console.info('addAbilityMonitor promise');
});

addAbilityMonitorSync¹⁰⁺

addAbilityMonitorSync(monitor: AbilityMonitor): void;

同步添加AbilityMonitor实例

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

参数：

参数名	类型	必填	说明
monitor	AbilityMonitor	是	AbilityMonitor实例

错误码：

错误码ID	错误信息
16000100	AddAbilityMonitorSync failed.
401	If the input parameter is not valid parameter.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

function onAbilityCreateCallback(data: UIAbility) {
    console.info('onAbilityCreateCallback');
}

let monitor: AbilityDelegatorRegistry.AbilityMonitor = {
    abilityName: 'abilityname',
    onAbilityCreate: onAbilityCreateCallback
};
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitorSync(monitor);

removeAbilityMonitor⁹⁺

removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback<void>): void;

删除已经添加的AbilityMonitor实例（callback形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityMonitor	是	AbilityMonitor实例
callback	AsyncCallback<void>	是	表示指定的回调方法

错误码：

错误码ID	错误信息
16000100	RemoveAbilityMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

function onAbilityCreateCallback(data: UIAbility) {
    console.info('onAbilityCreateCallback');
}

let monitor: AbilityDelegatorRegistry.AbilityMonitor = {
    abilityName: 'abilityname',
    onAbilityCreate: onAbilityCreateCallback
};

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityMonitor(monitor, (error: BusinessError) => {
    console.error(`removeAbilityMonitor fail, error: ${JSON.stringify(error)}`);
});

removeAbilityMonitor⁹⁺

removeAbilityMonitor(monitor: AbilityMonitor): Promise<void>;

删除已经添加的AbilityMonitor实例（promise形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityMonitor	是	AbilityMonitor实例

返回值：

类型	说明
Promise<void>	以Promise形式返回。

错误码：

错误码ID	错误信息
16000100	RemoveAbilityMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

function onAbilityCreateCallback(data: UIAbility) {
    console.info('onAbilityCreateCallback');
}

let monitor: AbilityDelegatorRegistry.AbilityMonitor = {
    abilityName: 'abilityname',
    onAbilityCreate: onAbilityCreateCallback
};

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityMonitor(monitor).then(() => {
    console.info('removeAbilityMonitor promise');
});

removeAbilityMonitorSync¹⁰⁺

removeAbilityMonitorSync(monitor: AbilityMonitor): void;

同步删除已经添加的AbilityMonitor实例

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

参数：

参数名	类型	必填	说明
monitor	AbilityMonitor	是	AbilityMonitor实例

错误码：

错误码ID	错误信息
16000100	RemoveAbilityMonitorSync failed.
401	If the input parameter is not valid parameter.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

function onAbilityCreateCallback(data: UIAbility) {
    console.info('onAbilityCreateCallback');
}

let monitor: AbilityDelegatorRegistry.AbilityMonitor = {
    abilityName: 'abilityname',
    onAbilityCreate: onAbilityCreateCallback
};

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityMonitorSync(monitor);

waitAbilityMonitor⁹⁺

waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback<UIAbility>): void;

等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（callback形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityMonitor	是	AbilityMonitor实例
callback	AsyncCallback<UIAbility>	是	表示指定的回调方法

错误码：

错误码ID	错误信息
16000100	WaitAbilityMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

function onAbilityCreateCallback(data: UIAbility) {
    console.info('onAbilityCreateCallback');
}

let monitor: AbilityDelegatorRegistry.AbilityMonitor = {
    abilityName: 'abilityname',
    onAbilityCreate: onAbilityCreateCallback
};

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor, (error : BusinessError, data : UIAbility) => {
    if (error) {
        console.error(`waitAbilityMonitor fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`waitAbilityMonitor success, data: ${JSON.stringify(data)}`);
    }
});

waitAbilityMonitor⁹⁺

waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback<UIAbility>): void;

设置等待时间，等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（callback形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityMonitor	是	AbilityMonitor实例
timeout	number	是	最大等待时间，单位毫秒（ms）
callback	AsyncCallback<UIAbility>	是	表示指定的回调方法

错误码：

错误码ID	错误信息
16000100	WaitAbilityMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let timeout = 100;

function onAbilityCreateCallback(data: UIAbility) {
    console.info('onAbilityCreateCallback');
}

let monitor: AbilityDelegatorRegistry.AbilityMonitor = {
    abilityName: 'abilityname',
    onAbilityCreate: onAbilityCreateCallback
};

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor, timeout, (error : BusinessError, data : UIAbility) => {
    if (error && error.code !== 0) {
        console.error(`waitAbilityMonitor fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`waitAbilityMonitor success, data: ${JSON.stringify(data)}`);
    }
});

waitAbilityMonitor⁹⁺

waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise<UIAbility>;

设置等待时间，等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（promise形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityMonitor	是	AbilityMonitor实例
timeout	number	否	最大等待时间，单位毫秒（ms）

返回值：

类型	说明
Promise<UIAbility>	以Promise形式返回Ability。

错误码：

错误码ID	错误信息
16000100	WaitAbilityMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

function onAbilityCreateCallback(data: UIAbility) {
    console.info('onAbilityCreateCallback');
}

let monitor: AbilityDelegatorRegistry.AbilityMonitor = {
    abilityName: 'abilityname',
    onAbilityCreate: onAbilityCreateCallback
};

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor).then((data : UIAbility) => {
    console.info('waitAbilityMonitor promise');
});

getAppContext⁹⁺

getAppContext(): Context;

获取应用Context

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

返回值：

类型	说明
Context	应用Context。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
let context = abilityDelegator.getAppContext();

getAbilityState⁹⁺

getAbilityState(ability: UIAbility): number;

获取指定ability的生命周期状态

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

参数：

参数名	类型	必填	说明
ability	UIAbility	是	指定Ability对象

返回值：

类型	说明
number	指定ability的生命周期状态。状态枚举值使用AbilityLifecycleState。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let ability: UIAbility;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : BusinessError, data : UIAbility) => {
    console.info('getCurrentTopAbility callback');
    ability = data;
    let state = abilityDelegator.getAbilityState(ability);
    console.info('getAbilityState ${state}');
});

getCurrentTopAbility⁹⁺

getCurrentTopAbility(callback: AsyncCallback<UIAbility>): void;

获取当前应用顶部ability（callback形式）

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<UIAbility>	是	表示指定的回调方法

错误码：

错误码ID	错误信息
16000100	GetCurrentTopAbility failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let ability: UIAbility;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : BusinessError, data : UIAbility) => {
    console.info('getCurrentTopAbility callback');
    ability = data;
});

getCurrentTopAbility⁹⁺

getCurrentTopAbility(): Promise<UIAbility>;

获取当前应用顶部ability（promise形式）

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

返回值：

类型	说明
Promise<UIAbility>	以Promise形式返回当前应用顶部ability。

错误码：

错误码ID	错误信息
16000100	GetCurrentTopAbility failed.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let ability: UIAbility;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility().then((data : UIAbility) => {
    console.info('getCurrentTopAbility promise');
    ability = data;
});

startAbility⁹⁺

startAbility(want: Want, callback: AsyncCallback<void>): void;

启动指定ability（callback形式）

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

参数：

参数名	类型	必填	说明
want	Want	是	启动Ability参数
callback	AsyncCallback<void>	是	表示指定的回调方法

错误码：

错误码ID	错误信息
16000001	The specified ability does not exist.
16000002	Incorrect ability type.
16000004	Can not start invisible component.
16000005	The specified process does not have the permission.
16000006	Cross-user operations are not allowed.
16000008	The crowdtesting application expires.
16000009	An ability cannot be started or stopped in Wukong mode.
16000010	The call with the continuation flag is forbidden.
16000011	The context does not exist.
16000012	The application is controlled.
16000013	The application is controlled by EDM.
16000050	Internal error.
16000053	The ability is not on the top of the UI.
16000055	Installation-free timed out.
16200001	The caller has been released.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let want: Want = {
    bundleName: 'bundleName',
    abilityName: 'abilityName'
};

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.startAbility(want, (err : BusinessError, data : void) => {
    console.info('startAbility callback');
});

startAbility⁹⁺

startAbility(want: Want): Promise<void>;

启动指定ability（promise形式）

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

参数：

参数名	类型	必填	说明
want	Want	是	启动Ability参数

返回值：

类型	说明
Promise<void>	以Promise形式返回。

错误码：

错误码ID	错误信息
16000001	The specified ability does not exist.
16000002	Incorrect ability type.
16000004	Can not start invisible component.
16000005	The specified process does not have the permission.
16000006	Cross-user operations are not allowed.
16000008	The crowdtesting application expires.
16000009	An ability cannot be started or stopped in Wukong mode.
16000010	The call with the continuation flag is forbidden.
16000011	The context does not exist.
16000012	The application is controlled.
16000013	The application is controlled by EDM.
16000050	Internal error.
16000053	The ability is not on the top of the UI.
16000055	Installation-free timed out.
16200001	The caller has been released.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let want: Want = {
    bundleName: 'bundleName',
    abilityName: 'abilityName'
};

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.startAbility(want).then((data: void) => {
    console.info('startAbility promise');
});

doAbilityForeground⁹⁺

doAbilityForeground(ability: UIAbility, callback: AsyncCallback<void>): void;

调度指定ability生命周期状态到Foreground状态（callback形式）

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

参数：

参数名	类型	必填	说明
ability	UIAbility	是	指定Ability对象
callback	AsyncCallback<void>	是	表示指定的回调方法 - true：成功 - false：失败

错误码：

错误码ID	错误信息
16000100	DoAbilityForeground failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let ability: UIAbility;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : BusinessError, data : UIAbility) => {
    console.info('getCurrentTopAbility callback');
    ability = data;
    abilityDelegator.doAbilityForeground(ability, (err : BusinessError) => {
        console.info("doAbilityForeground callback");
    });
});

doAbilityForeground⁹⁺

doAbilityForeground(ability: UIAbility): Promise<void>;

调度指定ability生命周期状态到Foreground状态（promise形式）

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

参数：

参数名	类型	必填	说明
ability	UIAbility	是	指定Ability对象

返回值：

类型	说明
Promise<boolean>	以Promise形式返回执行结果。 - true：成功 - false：失败

错误码：

错误码ID	错误信息
16000100	DoAbilityForeground failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let ability: UIAbility;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : BusinessError, data : UIAbility) => {
    console.info('getCurrentTopAbility callback');
    ability = data;
    abilityDelegator.doAbilityForeground(ability).then(() => {
        console.info("doAbilityForeground promise");
    });
});

doAbilityBackground⁹⁺

doAbilityBackground(ability: UIAbility, callback: AsyncCallback<void>): void;

调度指定ability生命周期状态到Background状态（callback形式）

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

参数：

参数名	类型	必填	说明
ability	UIAbility	是	指定Ability对象
callback	AsyncCallback<void>	是	表示指定的回调方法 - true：成功 - false：失败

错误码：

错误码ID	错误信息
16000100	DoAbilityBackground failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let ability: UIAbility;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : BusinessError, data : UIAbility) => {
    console.info('getCurrentTopAbility callback');
    ability = data;
    abilityDelegator.doAbilityBackground(ability, (err : BusinessError) => {
        console.info("doAbilityBackground callback");
    });
});

doAbilityBackground⁹⁺

doAbilityBackground(ability: UIAbility): Promise<void>;

调度指定ability生命周期状态到Background状态（promise形式）

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

参数：

参数名	类型	必填	说明
ability	UIAbility	是	指定Ability对象

返回值：

类型	说明
Promise<boolean>	以Promise形式返回执行结果。 - true：成功 - false：失败

错误码：

错误码ID	错误信息
16000100	DoAbilityBackground failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let ability: UIAbility;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : BusinessError, data : UIAbility) => {
    console.info('getCurrentTopAbility callback');
    ability = data;
    abilityDelegator.doAbilityBackground(ability).then(() => {
        console.info("doAbilityBackground promise");
    });
});

printSync⁹⁺

printSync(msg: string): void;

打印日志信息到单元测试终端控制台

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

参数：

参数名	类型	必填	说明
msg	string	是	日志字符串

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let msg = 'msg';

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.printSync(msg);

print

print(msg: string, callback: AsyncCallback<void>): void;

打印日志信息到单元测试终端控制台（callback形式）

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

参数：

参数名	类型	必填	说明
msg	string	是	日志字符串
callback	AsyncCallback<void>	是	表示指定的回调方法

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let msg = 'msg';

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.print(msg, (err : BusinessError) => {
    console.info('print callback');
});

print

print(msg: string): Promise<void>;

打印日志信息到单元测试终端控制台（promise形式）

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

参数：

参数名	类型	必填	说明
msg	string	是	日志字符串

返回值：

类型	说明
Promise<void>	以Promise形式返回。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let msg = 'msg';

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.print(msg).then(() => {
    console.info('print promise');
});

executeShellCommand

executeShellCommand(cmd: string, callback: AsyncCallback<ShellCmdResult>): void;

执行指定的shell命令（callback形式）

仅支持如下shell命令：aa, bm, cp, mkdir, rm, uinput, hilog, ppwd, echo, uitest, acm, hidumper, wukong, pkill, ps, pidof

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

参数：

参数名	类型	必填	说明
cmd	string	是	shell命令字符串
callback	AsyncCallback<ShellCmdResult>	是	表示指定的回调方法

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let cmd = 'cmd';

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, (err : BusinessError, data: AbilityDelegatorRegistry.ShellCmdResult) => {
    console.info('executeShellCommand callback');
});

executeShellCommand

executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback<ShellCmdResult>): void;

指定超时时间，并执行指定的shell命令（callback形式）

仅支持如下shell命令：aa, bm, cp, mkdir, rm, uinput, hilog, ppwd, echo, uitest, acm, hidumper, wukong, pkill, ps, pidof

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

参数：

参数名	类型	必填	说明
cmd	string	是	shell命令字符串
timeoutSecs	number	是	设定命令超时时间，单位秒（s）
callback	AsyncCallback<ShellCmdResult>	是	表示指定的回调方法

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let cmd = 'cmd';
let timeout = 100;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, timeout, (err : BusinessError, data: AbilityDelegatorRegistry.ShellCmdResult) => {
    console.info('executeShellCommand callback');
});

executeShellCommand

executeShellCommand(cmd: string, timeoutSecs?: number): Promise<ShellCmdResult>;

指定超时时间，并执行指定的shell命令（promise形式）

仅支持如下shell命令：aa, bm, cp, mkdir, rm, uinput, hilog, ppwd, echo, uitest, acm, hidumper, wukong, pkill, ps, pidof

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

参数：

参数名	类型	必填	说明
cmd	string	是	shell命令字符串
timeoutSecs	number	否	设定命令超时时间，单位秒（s）

返回值：

类型	说明
Promise<ShellCmdResult>	以Promise形式返回Shell命令执行结果ShellCmdResult对象。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let cmd = 'cmd';
let timeout = 100;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, timeout).then((data) => {
    console.info('executeShellCommand promise');
});

finishTest⁹⁺

finishTest(msg: string, code: number, callback: AsyncCallback<void>): void;

结束测试并打印日志信息到单元测试终端控制台（callback形式）

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

参数：

参数名	类型	必填	说明
msg	string	是	日志字符串
code	number	是	日志码
callback	AsyncCallback<void>	是	表示指定的回调方法

错误码：

错误码ID	错误信息
16000100	FinishTest failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let msg = 'msg';

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.finishTest(msg, 0, (err : BusinessError) => {
    console.info('finishTest callback');
});

finishTest⁹⁺

finishTest(msg: string, code: number): Promise<void>;

结束测试并打印日志信息到单元测试终端控制台（promise形式）

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

参数：

参数名	类型	必填	说明
msg	string	是	日志字符串
code	number	是	日志码

返回值：

类型	说明
Promise<void>	以Promise形式返回。

错误码：

错误码ID	错误信息
16000100	FinishTest failed.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let msg = 'msg';

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.finishTest(msg, 0).then(() => {
    console.info('finishTest promise');
});

addAbilityStageMonitor⁹⁺

addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback<void>): void;

添加一个AbilityStageMonitor对象，用于监视指定abilityStage的生命周期状态更改。（callback形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityStageMonitor	是	AbilityStageMonitor 实例
callback	AsyncCallback<void>	是	表示指定的回调方法

错误码：

错误码ID	错误信息
16000100	AddAbilityStageMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityStageMonitor({
    moduleName: 'moduleName',
    srcEntrance: 'srcEntrance',
}, (err : BusinessError) => {
    console.info('addAbilityStageMonitor callback');
});

addAbilityStageMonitor⁹⁺

addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise<void>;

添加一个AbilityStageMonitor对象，用于监视指定abilityStage的生命周期状态更改。（promise形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityStageMonitor	是	AbilityStageMonitor 实例

返回值：

类型	说明
Promise<void>	以Promise形式返回。

错误码：

错误码ID	错误信息
16000100	AddAbilityStageMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityStageMonitor({
    moduleName: 'moduleName',
    srcEntrance: 'srcEntrance',
}).then(() => {
    console.info('addAbilityStageMonitor promise');
});

addAbilityStageMonitorSync¹⁰⁺

addAbilityStageMonitorSync(monitor: AbilityStageMonitor): void;

同步添加一个AbilityStageMonitor对象，用于监视指定abilityStage的生命周期状态更改。

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

参数：

参数名	类型	必填	说明
monitor	AbilityStageMonitor	是	AbilityStageMonitor 实例
callback	AsyncCallback<void>	是	表示指定的回调方法

错误码：

错误码ID	错误信息
16000100	AddAbilityStageMonitorSync failed.
401	If the input parameter is not valid parameter.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityStageMonitorSync({
    moduleName: 'moduleName',
    srcEntrance: 'srcEntrance',
});

removeAbilityStageMonitor⁹⁺

removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback<void>): void;

从应用程序内存中删除指定的AbilityStageMonitor对象。（callback形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityStageMonitor	是	AbilityStageMonitor 实例
callback	AsyncCallback<void>	是	表示指定的回调方法

错误码：

错误码ID	错误信息
16000100	RemoveAbilityStageMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityStageMonitor({
    moduleName: 'moduleName',
    srcEntrance: 'srcEntrance',
}, (err : BusinessError) => {
    console.info('removeAbilityStageMonitor callback');
});

removeAbilityStageMonitor⁹⁺

removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise<void>;

从应用程序内存中删除指定的AbilityStageMonitor对象。（promise形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityStageMonitor	是	AbilityStageMonitor 实例

返回值：

类型	说明
Promise<void>	以Promise形式返回。

错误码：

错误码ID	错误信息
16000100	RemoveAbilityStageMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityStageMonitor({
    moduleName: 'moduleName',
    srcEntrance: 'srcEntrance',
}).then(() => {
    console.info('removeAbilityStageMonitor promise');
});

removeAbilityStageMonitorSync¹⁰⁺

removeAbilityStageMonitorSync(monitor: AbilityStageMonitor): void;

同步从应用程序内存中删除指定的AbilityStageMonitor对象。

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

参数：

参数名	类型	必填	说明
monitor	AbilityStageMonitor	是	AbilityStageMonitor 实例

错误码：

错误码ID	错误信息
16000100	removeAbilityStageMonitorSync failed.
401	If the input parameter is not valid parameter.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityStageMonitorSync({
    moduleName: 'moduleName',
    srcEntrance: 'srcEntrance',
});

waitAbilityStageMonitor⁹⁺

waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback<AbilityStage>): void;

等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象。（callback形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityStageMonitor	是	AbilityStageMonitor 实例
callback	AsyncCallback<AbilityStage>	是	成功返回AbilityStage对象，失败返回空。

错误码：

错误码ID	错误信息
16000100	WaitAbilityStageMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityStageMonitor({
    moduleName: 'moduleName',
    srcEntrance: 'srcEntrance',
}, (err : BusinessError, data : AbilityStage) => {
    console.info('waitAbilityStageMonitor callback');
});

waitAbilityStageMonitor⁹⁺

waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise<AbilityStage>;

等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象。（promise形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityStageMonitor	是	AbilityStageMonitor 实例
timeout	number	否	超时最大等待时间，以毫秒为单位。

返回值：

类型	说明
Promise<AbilityStage>	成功返回AbilityStage对象，失败返回空。

错误码：

错误码ID	错误信息
16000100	WaitAbilityStageMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityStageMonitor({
    moduleName: 'moduleName',
    srcEntrance: 'srcEntrance',
}).then((data : AbilityStage) => {
    console.info('waitAbilityStageMonitor promise');
});

waitAbilityStageMonitor⁹⁺

waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback: AsyncCallback<AbilityStage>): void;

等待并返回与给定AbilityStageMonitor中设置的条件匹配的AbilityStage对象。（callback形式）

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

参数：

参数名	类型	必填	说明
monitor	AbilityStageMonitor	是	AbilityStageMonitor 实例
timeout	number	是	超时最大等待时间，以毫秒为单位。
callback	AsyncCallback<AbilityStage>	是	成功返回AbilityStage对象，失败返回空。

错误码：

错误码ID	错误信息
16000100	WaitAbilityStageMonitor failed.

以上错误码详细介绍请参考errcode-ability。

示例：

import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
import AbilityStage from '@ohos.app.ability.AbilityStage';
import { BusinessError } from '@ohos.base';

let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
let timeout = 100;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityStageMonitor({
    moduleName: 'moduleName',
    srcEntrance: 'srcEntrance',
}, timeout, (err : BusinessError, data : AbilityStage) => {
    console.info('waitAbilityStageMonitor callback');
});

setMockList¹¹⁺

setMockList(mockList: { [key: string]: string }): void;

设置模块的mock替换关系。

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

参数：

参数名	类型	必填	说明
mockList	{ [key: string]: string }	是	模块mock替换关系的键值对象，其中key为待替换的目标路径，value为用于替换的mock实现文件的路径。

错误码：

错误码ID	错误信息
16000050	Internal error.

以上错误码详细介绍请参考errcode-ability。

示例：

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

let mockList: Record<string, string> = {
    '@ohos.router': 'src/main/mock/ohos/router.mock',
    'common.time': 'src/main/mock/common/time.mock',
};
let abilityDelegator: AbilityDelegatorRegistry.AbilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.setMockList(mockList);

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/cc66b6821a144f18b87b4ab7f27fa00e

harmony 鸿蒙AbilityDelegator

AbilityDelegator

导入模块

使用说明

AbilityDelegator

addAbilityMonitor9+

addAbilityMonitor9+

addAbilityMonitorSync10+

removeAbilityMonitor9+

removeAbilityMonitor9+

removeAbilityMonitorSync10+

waitAbilityMonitor9+

waitAbilityMonitor9+

waitAbilityMonitor9+

getAppContext9+

getAbilityState9+

getCurrentTopAbility9+

getCurrentTopAbility9+

startAbility9+

startAbility9+

doAbilityForeground9+

doAbilityForeground9+

doAbilityBackground9+

doAbilityBackground9+

printSync9+

print

print

executeShellCommand

executeShellCommand

executeShellCommand

finishTest9+

finishTest9+

addAbilityStageMonitor9+

addAbilityStageMonitor9+

addAbilityStageMonitorSync10+

removeAbilityStageMonitor9+

removeAbilityStageMonitor9+

removeAbilityStageMonitorSync10+

waitAbilityStageMonitor9+

waitAbilityStageMonitor9+

waitAbilityStageMonitor9+

setMockList11+

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

addAbilityMonitor⁹⁺

addAbilityMonitor⁹⁺

addAbilityMonitorSync¹⁰⁺

removeAbilityMonitor⁹⁺

removeAbilityMonitor⁹⁺

removeAbilityMonitorSync¹⁰⁺

waitAbilityMonitor⁹⁺

waitAbilityMonitor⁹⁺

waitAbilityMonitor⁹⁺

getAppContext⁹⁺

getAbilityState⁹⁺

getCurrentTopAbility⁹⁺

getCurrentTopAbility⁹⁺

startAbility⁹⁺

startAbility⁹⁺

doAbilityForeground⁹⁺

doAbilityForeground⁹⁺

doAbilityBackground⁹⁺

doAbilityBackground⁹⁺

printSync⁹⁺

finishTest⁹⁺

finishTest⁹⁺

addAbilityStageMonitor⁹⁺

addAbilityStageMonitor⁹⁺

addAbilityStageMonitorSync¹⁰⁺

removeAbilityStageMonitor⁹⁺

removeAbilityStageMonitor⁹⁺

removeAbilityStageMonitorSync¹⁰⁺

waitAbilityStageMonitor⁹⁺

waitAbilityStageMonitor⁹⁺

waitAbilityStageMonitor⁹⁺

setMockList¹¹⁺