ServiceExtensionContext

ServiceExtensionContext模塊是ServiceExtension的上下文環境，繼承自ExtensionContext。

ServiceExtensionContext模塊提供ServiceExtension具有的能力和接口，包括啟動、停止、綁定、解綁Ability。

說明：
開發前請熟悉鴻蒙開發指導文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模塊首批接口從API version 9開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。
本模塊接口僅可在Stage模型下使用。

使用說明

ServiceExtensionContext模塊是ServiceExtension的上下文環境，繼承自ExtensionContext。

屬性

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

startAbility

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

啟動Ability。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

示例：

import ExtensionContext from '@ohos.application.ServiceExtensionAbility';
class MainAbility extends ExtensionContext {
    onWindowStageCreate(windowStage) {
        let want = {
            "bundleName": "com.example.myapp",
            "abilityName": "MyAbility"};
        this.context.startAbility(want, (err) = > {
        console.log('startAbility result:' + JSON.stringify(err));
        });
    }
}

startAbility

startAbility(want: Want, options?: StartOptions): Promise;

啟動Ability。通過Promise返回結果。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

返回值：

示例：

import ExtensionContext from '@ohos.application.ServiceExtensionAbility';
  class MainAbility extends ExtensionContext {
      onWindowStageCreate(windowStage) {
          let want = {
          "bundleName": "com.example.myapp",
          "abilityName": "MyAbility"
          };
      this.context.startAbility(want).then((data) = > {
          console.log('success:' + JSON.stringify(data));
      }).catch((error) = > {
          console.log('failed:' + JSON.stringify(error));
      });
      }
  }

startAbility

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

啟動Ability。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

示例：

var want = {
	"deviceId": "",
	"bundleName": "com.extreme.test",
	"abilityName": "MainAbility"
};
var options = {
	windowMode: 0,
};
this.context.startAbility(want, options, (error) = > {
    console.log("error.code = " + error.code)
})

ServiceExtensionContext.startAbilityWithAccount

startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback): void;

根據account啟動Ability（callback形式）。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "MainAbility"
};
var accountId = 100;
this.context.startAbilityWithAccount(want, accountId, (err) = > {
  console.log('---------- startAbilityWithAccount fail, err:  -----------', err);
});

ServiceExtensionContext.startAbilityWithAccount

startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback): void;

根據account啟動Ability（callback形式）。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "MainAbility"
};
var accountId = 100;
var options = {
  windowMode: 0,
};
this.context.startAbilityWithAccount(want, accountId, options, (err) = > {
  console.log('---------- startAbilityWithAccount fail, err:  -----------', err);
});

ServiceExtensionContext.startAbilityWithAccount

startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise;

根據account啟動Ability（Promise形式）。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "MainAbility"
};
var accountId = 100;
var options = {
  windowMode: 0,
};
this.context.startAbilityWithAccount(want, accountId, options)
  .then((data) = > {
      console.log('---------- startAbilityWithAccount success, data:  -----------', data);
  })
  .catch((err) = > {
      console.log('---------- startAbilityWithAccount fail, err:  -----------', err);
  })

ServiceExtensionContext.terminateSelf

terminateSelf(callback: AsyncCallback): void;

停止Ability自身。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

示例：

import ExtensionContext from '@ohos.application.ServiceExtensionAbility';
      class MainAbility extends ExtensionContext {
          onWindowStageCreate(windowStage) {
          this.context.terminateSelf((err) = > {
            console.log('terminateSelf result:' + JSON.stringify(err));
          });
          }
      }

ServiceExtensionContext.terminateSelf

terminateSelf(): Promise;

停止自身。通過Promise返回結果。

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

系統API : 此接口為系統接口，三方應用不支持調用。

返回值：

示例：

import ExtensionContext from '@ohos.application.ServiceExtensionAbility';
  class MainAbility extends ExtensionContext {
  onWindowStageCreate(windowStage) {
    this.context.terminateSelf().then((data) = > {
      console.log('success:' + JSON.stringify(data));
    }).catch((error) = > {
      console.log('failed:' + JSON.stringify(error));
    });
  }
}

ServiceExtensionContext.connectAbility

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

將一個Ability與服務類型的Ability綁定。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

返回值：

示例：

let want = {
    "bundleName": "com.example.myapp",
    "abilityName": "MyAbility"
};
let options = {
    onConnect: function(elementName, proxy) {},
    onDisConnect: function(elementName) {},
    onFailed: function(code) {}
}
let connection = this.context.connectAbility(want,options);

ServiceExtensionContext.connectAbilityWithAccount

connectAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;

使用AbilityInfo.AbilityType.SERVICE模板和account將當前能力連接到一個能力。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

返回值：

示例：

var want = {
  "deviceId": "",
  "bundleName": "com.extreme.test",
  "abilityName": "MainAbility"
};
var accountId = 100;
var options = {
  onConnect(elementName, remote) { console.log('----------- onConnect -----------') },
  onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
  onFailed(code) { console.log('----------- onFailed -----------') }
}
const result = this.context.connectAbilityWithAccount(want, accountId, options);
console.log('----------- connectAbilityResult: ------------', result);

ServiceExtensionContext.disconnectAbility

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

將一個Ability與綁定的服務類型的Ability解綁。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

示例：

import ExtensionContext from '@ohos.application.ServiceExtensionAbility';
  class MainAbility extends ExtensionContext {
  onWindowStageCreate(windowStage) {
    let connection=1
    this.context.disconnectAbility(connection, (err) = > { 
      // connection為connectAbility中的返回值
      console.log('terminateSelf result:' + JSON.stringify(err));
    });
  }
}

ServiceExtensionContext.disconnectAbility

disconnectAbility(connection: number): Promise;

將一個Ability與綁定的服務類型的Ability解綁。通過Promise返回結果。

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

系統API : 此接口為系統接口，三方應用不支持調用。

參數：

返回值：

示例：

import ExtensionContext from '@ohos.application.ServiceExtensionAbility';
class MainAbility extends ExtensionContext {
  onWindowStageCreate(windowStage) {
    let connection=1
    this.context.disconnectAbility(connection).then((data) = > { // connection為connectAbility中的返回值
    console.log('success:' + JSON.stringify(data));
    }).catch((error) = > {
    console.log('failed:' + JSON.stringify(error));
    });
  }
}

審核編輯 黃宇