AbilityDelegator

AbilityDelegator提供添加用于監(jiān)視指定能力的生命周期狀態(tài)更改的AbilityMonitor對(duì)象的能力，包括對(duì)AbilityMonitor實(shí)例的添加、刪除、等待ability到達(dá)OnCreate生命周期、設(shè)置等待時(shí)間等、獲取指定ability的生命周期狀態(tài)、獲取當(dāng)前應(yīng)用頂部ability、啟動(dòng)指定ability等。

說(shuō)明：

本模塊首批接口從API version 8開(kāi)始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

使用說(shuō)明

開(kāi)發(fā)前請(qǐng)熟悉鴻蒙開(kāi)發(fā)指導(dǎo)文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

通過(guò)AbilityDelegatorRegistry中g(shù)etAbilityDelegator方法獲取。

import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'

var abilityDelegator;

abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();

AbilityDelegator

addAbilityMonitor9+

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

添加AbilityMonitor實(shí)例（callback形式）

**系統(tǒng)能力：**SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

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實(shí)例（promise形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

返回值：

示例：

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

刪除已經(jīng)添加的AbilityMonitor實(shí)例（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

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

刪除已經(jīng)添加的AbilityMonitor實(shí)例（promise形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

返回值：

• 示例

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實(shí)例匹配的ability到達(dá)OnCreate生命周期，并返回ability實(shí)例（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

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

設(shè)置等待時(shí)間，等待與AbilityMonitor實(shí)例匹配的ability到達(dá)OnCreate生命周期，并返回ability實(shí)例（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

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

設(shè)置等待時(shí)間，等待與AbilityMonitor實(shí)例匹配的ability到達(dá)OnCreate生命周期，并返回ability實(shí)例（promise形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

返回值：

示例：

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

獲取應(yīng)用Context

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

返回值：

示例：

var abilityDelegator;

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

getAbilityState9+

getAbilityState(ability: Ability): number

獲取指定ability的生命周期狀態(tài)

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

返回值：

示例：

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

獲取當(dāng)前應(yīng)用頂部ability（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

var abilityDelegator;
var ability;

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

getCurrentTopAbility9+

getCurrentTopAbility(): Promise

獲取當(dāng)前應(yīng)用頂部ability（promise形式）

系統(tǒng)能力： 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

啟動(dòng)指定ability（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

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

啟動(dòng)指定ability（promise形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

返回值：

示例：

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

調(diào)度指定ability生命周期狀態(tài)到Foreground狀態(tài)（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

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

調(diào)度指定ability生命周期狀態(tài)到Foreground狀態(tài)（promise形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

返回值：

示例：

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

調(diào)度指定ability生命周期狀態(tài)到Background狀態(tài)（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

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

調(diào)度指定ability生命周期狀態(tài)到Background狀態(tài)（promise形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

返回值：

示例：

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

打印日志信息到單元測(cè)試終端控制臺(tái)（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

var abilityDelegator;
var msg = "msg";

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

print

print(msg: string): Promise

打印日志信息到單元測(cè)試終端控制臺(tái)（promise形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

返回值：

示例：

var abilityDelegator;
var msg = "msg";

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

executeShellCommand

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

執(zhí)行指定的shell命令（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

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

指定超時(shí)時(shí)間，并執(zhí)行指定的shell命令（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

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

指定超時(shí)時(shí)間，并執(zhí)行指定的shell命令（promise形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

返回值：

示例：

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

結(jié)束測(cè)試并打印日志信息到單元測(cè)試終端控制臺(tái)（callback形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

示例：

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

結(jié)束測(cè)試并打印日志信息到單元測(cè)試終端控制臺(tái)（promise形式）

系統(tǒng)能力： SystemCapability.Ability.AbilityRuntime.Core

參數(shù)：

返回值：

示例：

var abilityDelegator;
var msg = "msg";

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

審核編輯 黃宇