ServiceExtensionAbility
ServiceExtensionAbility模塊提供ServiceExtension服務擴展相關接口的能力。
說明:
本模塊首批接口從API version 9開始支持。后續(xù)版本的新增接口,采用上角標單獨標記接口的起始版本。
本模塊接口僅可在Stage模型下使用。
導入模塊
import ServiceExtension from '@ohos.application.ServiceExtensionAbility';
權限
無
開發(fā)前請熟悉鴻蒙開發(fā)指導文檔:[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
屬性
系統(tǒng)能力 :SystemCapability.Ability.AbilityRuntime.Core
系統(tǒng)API : 此接口為系統(tǒng)接口,三方應用不支持調(diào)用。
| 名稱 | 參數(shù)類型 | 可讀 | 可寫 | 說明 |
|---|---|---|---|---|
| context | [ServiceExtensionContext] | 是 | 否 | ServiceExtension的上下文環(huán)境,繼承自ExtensionContext。 |
ServiceExtensionAbility.onCreate
onCreate(want: Want): void;
Extension生命周期回調(diào),在創(chuàng)建時回調(diào),執(zhí)行初始化業(yè)務邏輯操作。
系統(tǒng)能力 :SystemCapability.Ability.AbilityRuntime.Core
系統(tǒng)API : 此接口為系統(tǒng)接口,三方應用不支持調(diào)用。
參數(shù):
| 參數(shù)名 | 類型 | 必填 | 說明 |
|---|---|---|---|
| want | [Want] | 是 | 當前Extension相關的Want類型信息,包括ability名稱、bundle名稱等。 |
示例:
class ServiceExt extends ServiceExtension {
onCreate(want) {
console.log('onCreate, want:' + want.abilityName);
}
}
ServiceExtensionAbility.onDestroy
onDestroy(): void;
Extension生命周期回調(diào),在銷毀時回調(diào),執(zhí)行資源清理等操作。
系統(tǒng)能力 :SystemCapability.Ability.AbilityRuntime.Core
系統(tǒng)API : 此接口為系統(tǒng)接口,三方應用不支持調(diào)用。
示例:
class ServiceExt extends ServiceExtension {
onDestroy() {
console.log('onDestroy');
}
}
ServiceExtensionAbility.onRequest
onRequest(want: Want, startId: number): void;
Extension生命周期回調(diào),如果是startAbility拉起的服務,會在onCreate之后回調(diào)。每次拉起服務都會回調(diào),startId會遞增。
系統(tǒng)能力 :SystemCapability.Ability.AbilityRuntime.Core
系統(tǒng)API : 此接口為系統(tǒng)接口,三方應用不支持調(diào)用。
參數(shù):
| 參數(shù)名 | 類型 | 必填 | 說明 |
|---|---|---|---|
| want | [Want] | 是 | 當前Extension相關的Want類型信息,包括ability名稱、bundle名稱等。 |
| startId | number | 是 | 返回拉起次數(shù)。首次拉起初始值返回1,多次之后自動遞增。 |
示例:
class ServiceExt extends ServiceExtension {
onRequest(want, startId) {
console.log('onRequest, want:' + want.abilityName);
}
}
ServiceExtensionAbility.onConnect
onConnect(want: Want): rpc.RemoteObject;
Extension生命周期回調(diào),如果是connectAbility拉起的服務,會在onCreate之后回調(diào)。返回一個RemoteObject對象,用于和客戶端進行通信。
系統(tǒng)能力 :SystemCapability.Ability.AbilityRuntime.Core
系統(tǒng)API : 此接口為系統(tǒng)接口,三方應用不支持調(diào)用。
參數(shù):
| 參數(shù)名 | 類型 | 必填 | 說明 |
|---|---|---|---|
| want | [Want | 是 | 當前Extension相關的Want類型信息,包括ability名稱、bundle名稱等。 |
返回值:
| 類型 | 說明 |
|---|---|
| rpc.RemoteObject | 一個RemoteObject對象,用于和客戶端進行通信。 |
示例:
import rpc from '@ohos.rpc'
class StubTest extends rpc.RemoteObject{
constructor(des) {
super(des);
}
onConnect(code, data, reply, option) {
}
}
class ServiceExt extends ServiceExtension {
onConnect(want) {
console.log('onConnect , want:' + want.abilityName);
return new StubTest("test");
}
}
ServiceExtensionAbility.onDisconnect
onDisconnect(want: Want): void;
Extension的生命周期,斷開服務連接時回調(diào)。
系統(tǒng)能力 :SystemCapability.Ability.AbilityRuntime.Core
系統(tǒng)API : 此接口為系統(tǒng)接口,三方應用不支持調(diào)用。
參數(shù):
| 參數(shù)名 | 類型 | 必填 | 說明 |
|---|---|---|---|
| want | [Want] | 是 | 當前Extension相關的Want類型信息,包括ability名稱、bundle名稱等。 |
示例:
class ServiceExt extends ServiceExtension {
onDisconnect(want) {
console.log('onDisconnect, want:' + want.abilityName);
}
}
ServiceExtensionAbility.onReconnect
onReconnect(want: Want): void;
當新客戶端在所有以前的客戶端連接之后嘗試連接到服務擴展時調(diào)用
系統(tǒng)能力 :SystemCapability.Ability.AbilityRuntime.Core
系統(tǒng)API : 此接口為系統(tǒng)接口,三方應用不支持調(diào)用。
參數(shù):
| 參數(shù)名 | 類型 | 必填 | 說明 |
|---|---|---|---|
| want | [Want] | 是 | 當前Extension相關的Want類型信息,包括ability名稱、bundle名稱等。 |
示例:
class ServiceExt extends ServiceExtension {
onDisconnect(want) {
console.log('onDisconnect, want:' + want.abilityName);
}
}
ServiceExtensionAbility.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
系統(tǒng)能力 :SystemCapability.Ability.AbilityRuntime.Core
系統(tǒng)API : 此接口為系統(tǒng)接口,三方應用不支持調(diào)用。
參數(shù):
| 參數(shù)名 | 類型 | 必填 | 說明 |
|---|---|---|---|
| config | [Configuration] | 是 | 表示需要更新的配置信息。 |
示例:
class ServiceExt extends ServiceExtension {
onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
}
}
ServiceExtensionAbility.dump
dump(params: Array): Array;
轉儲客戶端信息時調(diào)用。
系統(tǒng)能力 :SystemCapability.Ability.AbilityRuntime.Core
系統(tǒng)API : 此接口為系統(tǒng)接口,三方應用不支持調(diào)用。
參數(shù):
| 參數(shù)名 | 類型 | 必填 | 說明 |
|---|---|---|---|
| params | Array | 是 | 表示命令形式的參數(shù)。 |

示例:
class ServiceExt extends ServiceExtension {
dump(params) {
console.log('dump, params:' + JSON.stringify(params));
return ["params"]
}
}
審核編輯 黃宇
-
接口
+關注
關注
33文章
9307瀏覽量
155710 -
框架
+關注
關注
0文章
404瀏覽量
18258 -
鴻蒙
+關注
關注
60文章
2746瀏覽量
45138
發(fā)布評論請先 登錄
鴻蒙開發(fā)接口Ability框架:【@ohos.application.Ability (Ability)】
鴻蒙開發(fā)接口Ability框架:【@ohos.ability.featureAbility (FeatureAbility模塊)】
鴻蒙開發(fā)接口Ability框架:【@ohos.ability.particleAbility (particleAbility模塊)】
鴻蒙開發(fā)接口Ability框架:【 (Context模塊)】
鴻蒙開發(fā)接口Ability框架:【(AbilityDelegator)】
鴻蒙開發(fā)接口Ability框架:【AbilityDelegator】
鴻蒙Ability Kit(程序框架服務)【ServiceExtensionAbility】
鴻蒙Ability開發(fā)-Stage模型下Ability的創(chuàng)建和使用
鴻蒙開發(fā)接口Ability框架:【ApplicationContext】
鴻蒙Ability Kit(程序框架服務)【Ability與ServiceExtensionAbility通信】
鴻蒙開發(fā)Ability Kit程序框架服務:FA模型綁定Stage模型ServiceExtensionAbility

鴻蒙開發(fā)接口Ability框架:【 (ServiceExtensionAbility)】
評論