AbilityDelegator

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

说明：
开发前请熟悉鸿蒙开发指导文档：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模块首批接口从APIversion 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

使用说明

通过AbilityDelegatorRegistry中getAbilityDelegator方法获取。

import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
var abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();

AbilityDelegator

addAbilityMonitor9+

addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback): void

添加AbilityMonitor实例（callback形式）

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

参数：

示例：

var abilityDelegator;function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback");
}var monitor = {
abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback
}
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor, (err : any) = > {
console.info("addAbilityMonitor callback");
});

addAbilityMonitor9+

addAbilityMonitor(monitor: AbilityMonitor): Promise

添加AbilityMonitor实例（promise形式）

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

参数：

返回值：

示例：

var abilityDelegator;function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback");
}var monitor = {
abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback
}
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor).then(() = > {
console.info("addAbilityMonitor promise");
});

removeAbilityMonitor9+

removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback): void

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

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

参数：

示例：

var abilityDelegator;function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback");
}var monitor = {
abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback
}
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityMonitor(monitor, (err : any) = > {
console.info("removeAbilityMonitor callback");
});

removeAbilityMonitor9+

removeAbilityMonitor(monitor: AbilityMonitor): Promise

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

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

参数：

返回值：

• 示例

var abilityDelegator;function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback");
}var monitor = {
abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback
}
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityMonitor(monitor).then(() = > {
console.info("removeAbilityMonitor promise");
});

waitAbilityMonitor9+

waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback): void

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

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

参数：

示例：

var abilityDelegator;function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback");
}var monitor = {
abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback
}
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor, (err : any, data : any) = > {
console.info("waitAbilityMonitor callback");
});

waitAbilityMonitor9+

waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback): void

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

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

参数：

示例：

var abilityDelegator;var timeout = 100;function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback");
}var monitor = {
abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback
}
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor, timeout, (err : any, data : any) = > {
console.info("waitAbilityMonitor callback");
});

waitAbilityMonitor9+

waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise

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

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

参数：

返回值：

示例：

var abilityDelegator;function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback");
}var monitor = {
abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback
}
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor).then((data : any) = > {
console.info("waitAbilityMonitor promise");
});

getAppContext9+

getAppContext(): Context

获取应用Context

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

返回值：

示例：

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

getAbilityState9+

getAbilityState(ability: Ability): number

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

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

参数：

返回值：

示例：

var abilityDelegator;var ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) = > {
console.info("getCurrentTopAbility callback");
    ability = data;
var state = abilityDelegator.getAbilityState(ability);
console.info("getAbilityState" + state);
});

getCurrentTopAbility9+

getCurrentTopAbility(callback: AsyncCallback): void

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

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

参数：

示例：

var abilityDelegator;var ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) = > {
console.info("getCurrentTopAbility callback");
    ability = data;
});

getCurrentTopAbility9+

getCurrentTopAbility(): Promise

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

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

返回值：

示例：

var abilityDelegator;var ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility().then((data : any) = > {
console.info("getCurrentTopAbility promise");
    ability = data;
});

startAbility9+

startAbility(want: Want, callback: AsyncCallback): void

启动指定ability（callback形式）

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

参数：

示例：

var abilityDelegator;var want = {
bundleName: "bundleName",
abilityName: "abilityName"
};
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.startAbility(want, (err : any, data : any) = > {
console.info("startAbility callback");
});

startAbility9+

startAbility(want: Want): Promise

启动指定ability（promise形式）

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

参数：

返回值：

示例：

var abilityDelegator;var want = {
bundleName: "bundleName",
abilityName: "abilityName"
};
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.startAbility(want).then((data: any) = > {
console.info("startAbility promise");
});

doAbilityForeground9+

doAbilityForeground(ability: Ability, callback: AsyncCallback): void

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

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

参数：

示例：

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

doAbilityForeground9+

doAbilityForeground(ability: Ability): Promise

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

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

参数：

返回值：

示例：

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

doAbilityBackground9+

doAbilityBackground(ability: Ability, callback: AsyncCallback): void

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

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

参数：

示例：

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

doAbilityBackground9+

doAbilityBackground(ability: Ability): Promise

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

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

参数：

返回值：

示例：

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

print

print(msg: string, callback: AsyncCallback): void

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

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

参数：

示例：

var abilityDelegator;var msg = "msg";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.print(msg, (err : any) = > {
    console.info("print callback");
});

print

print(msg: string): Promise

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

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

参数：

返回值：

示例：

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

executeShellCommand

executeShellCommand(cmd: string, callback: AsyncCallback): void

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

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

参数：

示例：

var abilityDelegator;var cmd = "cmd";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, (err : any, data : any) = > {
console.info("executeShellCommand callback");
});

executeShellCommand

executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback): void

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

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

参数：

示例：

var abilityDelegator;var cmd = "cmd";var timeout = 100;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) = > {
console.info("executeShellCommand callback");
});

executeShellCommand

executeShellCommand(cmd: string, timeoutSecs?: number): Promise

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

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

参数：

返回值：

示例：

var abilityDelegator;var cmd = "cmd";var timeout = 100;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) = > {
console.info("executeShellCommand promise");
});

finishTest9+

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

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

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

参数：

示例：

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

finishTest9+

finishTest(msg: string, code: number): Promise

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

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

参数：

返回值：

示例：

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

审核编辑 黄宇

.;9z.0