ServiceExtensionContext

NOTE

The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Implements the context that provides the capabilities and APIs of ServiceExtension. This class is inherited from ExtensionContext.

startAbility

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

Starts an ability. This API uses a callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Example

let want = {
    "bundleName": "com.example.myapp",
    "abilityName": "com.example.myapp.MyAbility"
};
this.context.startAbility(want, (err) => {
    console.log('startAbility result:' + JSON.stringify(err));
});

ServiceExtensionContext.startAbility

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

Starts an ability. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Return value

Example

let want = {
    "bundleName": "com.example.myapp",
    "abilityName": "com.example.myapp.MyAbility"
};
this.context.startAbility(want).then((data) => {
    console.log('success:' + JSON.stringify(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});

ServiceExtensionContext.terminateSelf

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

Terminates this ability. This API uses a callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Example

this.context.terminateSelf((err) => {
    console.log('terminateSelf result:' + JSON.stringify(err));
});

ServiceExtensionContext.terminateSelf

terminateSelf(): Promise<void>;

Terminates this ability. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Example

this.context.terminateSelf(want).then((data) => {
    console.log('success:' + JSON.stringify(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});

ServiceExtensionContext.connectAbility

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

Connects this ability to a Service ability.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Return value

Example

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);

ServiceExtensionContext.disconnectAbility

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

Disconnects this ability from the Service ability. This API uses a callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Example

this.context.disconnectAbility(connection, (err) => { // connection is the return value of connectAbility.
    console.log('terminateSelf result:' + JSON.stringify(err));
});

ServiceExtensionContext.disconnectAbility

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

Disconnects this ability from the Service ability. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Return value

Example

this.context.disconnectAbility(connection).then((data) => { // connection is the return value of connectAbility.
    console.log('success:' + JSON.stringify(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});

ConnectOptions

Defines the ConnectOptions data structure.

System capability: SystemCapability.Ability.AbilityRuntime.Core