@ohos.app.ability.DriverExtensionAbility (DriverExtensionAbility)

DriverExtensionAbility模块提供驱动相关扩展能力，提供驱动创建、销毁、连接、断开等生命周期回调。

说明：

本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。

导入模块

import DriverExtension from '@ohos.app.ability.DriverExtensionAbility';

权限

无

属性

系统能力：SystemCapability.Driver.ExternalDevice

DriverExtensionAbility.onInit

onInit(want: Want): void;

Extension生命周期回调，在创建时回调，执行初始化业务逻辑操作。

系统能力：SystemCapability.Driver.ExternalDevice

参数：

示例：

import DriverExtension from '@ohos.app.ability.DriverExtensionAbility';
import Want from '@ohos.app.ability.Want';
class DriverExt extends DriverExtension {
  onInit(want : Want) {
    console.log('onInit, want: ${want.abilityName}');
  }
}

DriverExtensionAbility.onRelease

onRelease(): void;

Extension生命周期回调，在销毁时回调，执行资源清理等操作。

系统能力：SystemCapability.Driver.ExternalDevice

示例：

class DriverExt extends DriverExtension {
  onRelease() {
    console.log('onRelease');
  }
}

DriverExtensionAbility.onConnect

onConnect(want: Want): rpc.RemoteObject | Promise<rpc.RemoteObject>;

Extension生命周期回调，如果是connectAbility拉起的服务，会在onCreate之后回调。返回一个RemoteObject对象，用于客户端和服务端进行通信。

系统能力：SystemCapability.Driver.ExternalDevice

参数：

返回值：

示例：

import DriverExtension from '@ohos.app.ability.DriverExtensionAbility';
import rpc from '@ohos.rpc';
import Want from '@ohos.app.ability.Want';
class StubTest extends rpc.RemoteObject{
    constructor(des : string) {
        super(des);
    }
    onRemoteMessageRequest(code : number, data : rpc.MessageSequence, reply : rpc.MessageSequence, option : rpc.MessageOption) {
      //必须重写此接口
      return true;
    }
}
class DriverExt extends DriverExtension {
  onConnect(want : Want) {
    console.log('onConnect , want: ${want.abilityName}');
    return new StubTest('test');
  }
}

如果生成返回值RemoteObject依赖一个异步接口，可以使用异步生命周期：

import DriverExtension from '@ohos.app.ability.DriverExtensionAbility';
import rpc from '@ohos.rpc';
import Want from '@ohos.app.ability.Want';
class StubTest extends rpc.RemoteObject{
  constructor(des : string) {
      super(des);
  }
  onRemoteMessageRequest(code : number, data : rpc.MessageSequence, reply : rpc.MessageSequence, option : rpc.MessageOption) {
    //必须重写此接口
    return true;
  }
}
async function getDescriptor() {
  // 调用异步函数...
  return "asyncTest"
}
class DriverExt extends DriverExtension {
async onConnect(want : Want) {
  console.log(`onConnect , want: ${want.abilityName}`);
  let descriptor = await getDescriptor();
  return new StubTest(descriptor);
}
}

DriverExtensionAbility.onDisconnect

onDisconnect(want: Want): void | Promise<void>;

Extension的生命周期回调，客户端执行断开连接服务时回调。

系统能力：SystemCapability.Driver.ExternalDevice

参数：

示例：

import DriverExtension from '@ohos.app.ability.DriverExtensionAbility';
import Want from '@ohos.app.ability.Want';
class DriverExt extends DriverExtension {
  onDisconnect(want : Want) {
    console.log('onDisconnect, want: ${want.abilityName}');
  }
}

在执行完onDisconnect生命周期回调后，应用可能会退出，从而可能导致onDisconnect中的异步函数未能正确执行，比如异步写入数据库。可以使用异步生命周期，以确保异步onDisconnect完成后再继续后续的生命周期。

import DriverExtension from '@ohos.app.ability.DriverExtensionAbility';
import Want from '@ohos.app.ability.Want';
class DriverExt extends DriverExtension {
async onDisconnect(want : Want) {
  console.log('onDisconnect, want: ${want.abilityName}');
  // 调用异步函数...
}
}

DriverExtensionAbility.onDump

onDump(params: Array<string>): Array<string>;

转储客户端信息时调用。

系统能力：SystemCapability.Driver.ExternalDevice

参数：

示例：

class DriverExt extends DriverExtension {
    onDump(params : Array<string>) {
        console.log(`dump, params: ${JSON.stringify(params)}`);
        return ['params'];
    }
}