ServiceExtensionContext


ServiceExtensionContext

icon-note.gif 说明: 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

ServiceExtension的上下文环境,提供ServiceExtension具有的能力和接口,继承自ExtensionContext。

startAbility

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

启动Ability。

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

参数:

参数名 类型 必填 说明
want Want Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。
callback AsyncCallback<void> 回调函数,返回接口调用是否成功的结果。

示例:

let want = {
    "bundleName": "com.example.myapp",
    "abilityName": "com.example.myapp.MyAbility"
};
this.context.startAbility(want, (err) => {
    console.log('startAbility result:' + JSON.stringfy(err));
});
1
2
3
4
5
6
7

ServiceExtensionContext.startAbility

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

启动Ability。通过Promise返回结果。

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

参数:

参数名 类型 必填 说明
want Want Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果。

示例:

let want = {
    "bundleName": "com.example.myapp",
    "abilityName": "com.example.myapp.MyAbility"
};
this.context.startAbility(want).then((data) => {
    console.log('success:' + JSON.stringfy(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringfy(error));
});
1
2
3
4
5
6
7
8
9

ServiceExtensionContext.terminateSelf

terminateSelf(callback: AsyncCallback<void>): void;

停止Ability自身。

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

参数:

参数名 类型 必填 说明
callback AsyncCallback<void> 回调函数,返回接口调用是否成功的结果。

示例:

this.context.terminateSelf((err) => {
    console.log('terminateSelf result:' + JSON.stringfy(err));
});
1
2
3

ServiceExtensionContext.terminateSelf

terminateSelf(): Promise<void>;

停止自身。通过Promise返回结果。

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

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果。

示例:

this.context.terminateSelf(want).then((data) => {
    console.log('success:' + JSON.stringfy(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringfy(error));
});
1
2
3
4
5

ServiceExtensionContext.connectAbility

connectAbility(want: Want, options: ConnectOptions): number;

将一个Ability与服务类型的Ability绑定。

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

参数:

参数名 类型 必填 说明
want Want Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。
options ConnectOptions ConnectOptions类型的回调函数,返回服务连接成功、断开或连接失败后的信息。

返回值:

类型 说明
number 返回一个number,后续根据这个number去断开连接。

示例:

let want = {
    "bundleName": "com.example.myapp",
    "abilityName": "com.example.myapp.MyAbility"
};
let options = {
    onConnect: function(elementName, proxy) {},
    onDisConnect: function(elementName) {},
    onFailed: function(code) {}
}
let connection = this.context.connectAbility(want,options);
1
2
3
4
5
6
7
8
9
10

ServiceExtensionContext.disconnectAbility

disconnectAbility(connection: number, callback:AsyncCallback<void>): void;

将一个Ability与绑定的服务类型的Ability解绑。

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

参数:

参数名 类型 必填 说明
connection number 在connectAbility中返回的number。
callback AsyncCallback<void> 回调函数,返回接口调用是否成功的结果。

示例:

this.context.disconnectAbility(connection, (err) => { // connection为connectAbility中的返回值
    console.log('terminateSelf result:' + JSON.stringfy(err));
});
1
2
3

ServiceExtensionContext.disconnectAbility

disconnectAbility(connection: number): Promise<void>;

将一个Ability与绑定的服务类型的Ability解绑。通过Promise返回结果。

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

参数:

参数名 类型 必填 说明
connection number 在connectAbility中返回的number。

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果。

示例:

this.context.disconnectAbility(connection).then((data) => { // connection为connectAbility中的返回值
    console.log('success:' + JSON.stringfy(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringfy(error));
});
1
2
3
4
5

ConnectOptions

ConnectOptions数据结构。

系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

名称 说明
onConnect(elementName:ElementName, remote:IRemoteObject) Ability成功连接一个服务类型Ability的回调接口。
onDisconnect(elementName:ElementName) 对端服务发生异常或者被杀死回调该接口。
onFailed(code: number) 连接失败时回调该接口。