ServiceExtensionAbility

ServiceExtensionAbility模塊提供ServiceExtension服務擴展相關接口的能力。

說明：

本模塊首批接口從API version 9開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。
本模塊接口僅可在Stage模型下使用。

導入模塊

import ServiceExtension from '@ohos.application.ServiceExtensionAbility';

權限

無

開發前請熟悉鴻蒙開發指導文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

屬性

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

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

ServiceExtensionAbility.onCreate

onCreate(want: Want): void;

Extension生命周期回調，在創建時回調，執行初始化業務邏輯操作。

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

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

參數：

示例：

class ServiceExt extends ServiceExtension {
  onCreate(want) {
    console.log('onCreate, want:' + want.abilityName);
  }
}

ServiceExtensionAbility.onDestroy

onDestroy(): void;

Extension生命周期回調，在銷毀時回調，執行資源清理等操作。

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

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

示例：

class ServiceExt extends ServiceExtension {
  onDestroy() {
    console.log('onDestroy');
  }
}

ServiceExtensionAbility.onRequest

onRequest(want: Want, startId: number): void;

Extension生命周期回調，如果是startAbility拉起的服務，會在onCreate之后回調。每次拉起服務都會回調，startId會遞增。

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

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

參數：

示例：

class ServiceExt extends ServiceExtension {
  onRequest(want, startId) {
    console.log('onRequest, want:' + want.abilityName);
  }
}

ServiceExtensionAbility.onConnect

onConnect(want: Want): rpc.RemoteObject;

Extension生命周期回調，如果是connectAbility拉起的服務，會在onCreate之后回調。返回一個RemoteObject對象，用于和客戶端進行通信。

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

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

參數：

返回值：

示例：

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的生命周期，斷開服務連接時回調。

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

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

參數：

示例：

class ServiceExt extends ServiceExtension {
  onDisconnect(want) {
    console.log('onDisconnect, want:' + want.abilityName);
  }
}

ServiceExtensionAbility.onReconnect

onReconnect(want: Want): void;

當新客戶端在所有以前的客戶端連接之后嘗試連接到服務擴展時調用

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

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

參數：

示例：

class ServiceExt extends ServiceExtension {
  onDisconnect(want) {
    console.log('onDisconnect, want:' + want.abilityName);
  }
}

ServiceExtensionAbility.onConfigurationUpdated

onConfigurationUpdated(config: Configuration): void;

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

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

參數：

示例：

class ServiceExt extends ServiceExtension {
    onConfigurationUpdated(config) {
        console.log('onConfigurationUpdated, config:' + JSON.stringify(config));
    }
}

ServiceExtensionAbility.dump

dump(params: Array): Array;

轉儲客戶端信息時調用。

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

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

參數：

示例：

class ServiceExt extends ServiceExtension {
    dump(params) {
        console.log('dump, params:' + JSON.stringify(params));
        return ["params"]
    }
}

審核編輯 黃宇