跳到主要内容

Class: Adapter

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:14

插件事件发布基类，主要用于平台bot接口适配，每个PluginAdapter适配器都是一个bot连接

Implements​

Constructors​

Constructor​

new Adapter(config): Adapter

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:30

Parameters​

config​

IAdapterConfig

Returns​

Adapter

Properties​

adapterID?​

optional adapterID: string

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:26

适配器标识符，创建PluginAdapter实例时自动获取，无需填写

Implementation of​

IAdapter.adapterID

api​

api: object = {}

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:28

主动接口，可注册Bot实例方法

Index Signature​

[key: string]: any

Implementation of​

IAdapter.api

description?​

optional description: string

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:18

适配器描述

Implementation of​

IAdapter.description

disable?​

optional disable: boolean = false

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:20

是否禁用该适配器

Implementation of​

IAdapter.disable

global?​

optional global: boolean = false

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:22

是否将此适配器应用于全局，默认false, 为true时其它插件都可用，此项由用户决定，作者不需要填写

Implementation of​

IAdapter.global

name​

name: string

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:16

适配器名称，此名称被视作唯一适配器id，请尽量用纯英文名，如onebot11

Implementation of​

IAdapter.name

pluginID​

pluginID: string = ''

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:24

插件包标识符，仅允许填PLUGIN_BASE_URI(该变量由加载时的运行环境提供)

Implementation of​

IAdapter.pluginID

Methods​

createHooks()​

createHooks<H>(hooks): { [K in string | number | symbol]: (args: TOmitFirstArg<Parameters<H[K]>>) => ReturnType<H[K]> }

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:133

创建绑定该适配器组件的钩子集合

Type Parameters​

H​

H extends Record<string, (__namedParameters, ...args) => any>

Parameters​

hooks​

H

多个钩子函数集合

Returns​

{ [K in string | number | symbol]: (args: TOmitFirstArg<Parameters<H[K]>>) => ReturnType<H[K]> }

emit()​

emit<Adapters, EventName>(eventType, e): Adapter

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:41

发布事件

Type Parameters​

Adapters​

Adapters extends IAdapterExport

EventName​

EventName extends string | number | symbol

Parameters​

eventType​

string

事件名称

e​

事件数据

Returns​

Adapter

emitToSystem()​

emitToSystem(eventType, event): void

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:108

向ov0系统发布消息

Parameters​

eventType​

string

event​

Returns​

void

mount()​

mount(pluginID): void

Defined in: packages/ov0/src/core/plugin/components/Adapter.ts:120

挂载适配器

Parameters​

pluginID​

string

插件包名(确保和github仓库名一致)

Returns​

void