PPAgent 文档

Appearance

ppagent / BotManager

Class: BotManager ​

Defined in: src/bot/bot.manager.ts:7

Extends ​

Constructors ​

Constructor ​

new BotManager(options?): BotManager

Defined in: src/instance.base.manager.ts:31

Parameters ​

options? ​

IInstanceBaseMangerOptions

Returns ​

BotManager

Inherited from ​

InstanceBaseManager.constructor

Methods ​

clearInstances() ​

clearInstances(): Promise<void>

Defined in: src/instance.base.manager.ts:112

Returns ​

Promise<void>

Inherited from ​

InstanceBaseManager.clearInstances

createInstance() ​

createInstance(name, options): IBot

Defined in: src/instance.base.manager.ts:91

创建实例

Parameters ​

name ​

string

options ​

IBotOptions

Returns ​

IBot

Inherited from ​

InstanceBaseManager.createInstance

getAllParams() ​

getAllParams(): object

Defined in: src/instance.base.manager.ts:57

Returns ​

object

Inherited from ​

InstanceBaseManager.getAllParams

getAllParamsArray() ​

getAllParamsArray(): IBotParams[]

Defined in: src/instance.base.manager.ts:61

Returns ​

IBotParams[]

Inherited from ​

InstanceBaseManager.getAllParamsArray

getInstance() ​

getInstance(instanceName): IBot

Defined in: src/instance.base.manager.ts:70

只有允许缓存实例的管理器才能够获取到创建过的实例

Parameters ​

instanceName ​

string

Returns ​

IBot

Inherited from ​

InstanceBaseManager.getInstance

getInstances() ​

getInstances(typeName?): IBot[]

Defined in: src/instance.base.manager.ts:78

获取某个类型的所有的实例

Parameters ​

typeName? ​

string

类型名称

Returns ​

IBot[]

Inherited from ​

InstanceBaseManager.getInstances

getParams() ​

getParams(name): IBotParams

Defined in: src/instance.base.manager.ts:53

根据固有名称获取其相关参数

Parameters ​

name ​

string

Returns ​

IBotParams

Inherited from ​

InstanceBaseManager.getParams

registerInstanceCreator() ​

registerInstanceCreator(creator, params): void

Defined in: src/instance.base.manager.ts:41

消息源创建器注册。一般由插件进行注册。

Parameters ​

creator ​

BotCreator

params ​

IBotParams

Returns ​

void

Inherited from ​

InstanceBaseManager.registerInstanceCreator

runBot() ​

runBot(instanceName, type, content, customData?, onStream?): Promise<{ all: object[]; text: string; }>

Defined in: src/bot/bot.manager.ts:8

Parameters ​

instanceName ​

string

type ​

SourceChatMessageType

content ​

SourceChatContent

customData? ​

IAgentChatEventData

onStream? ​

(type, content) => void

Returns ​

Promise<{ all: object[]; text: string; }>