ppagent / IPPAgentPluginHandler

Interface: IPPAgentPluginHandler

Defined in: src/plugin/plugin.ts:27

Extends

• IDisposable

Properties

afterStart()?

optional afterStart: () => Promise<void>

Defined in: src/plugin/plugin.ts:48

HTTP服务启动之后

Returns

Promise<void>

---

beforeClose()?

optional beforeClose: () => Promise<void>

Defined in: src/plugin/plugin.ts:53

在服务被关闭之前被调用

Returns

Promise<void>

---

beforeStart()?

optional beforeStart: () => Promise<void>

Defined in: src/plugin/plugin.ts:43

HTTP服务启动之前（agent和task创建之后）

Returns

Promise<void>

---

init()

init: () => Promise<{ bots: IInstanceCreator<IBotOptions, IBot, IBotParams>[]; skills: IInstanceCreator<ISkillOptions, ISkill, ISkillParams>[]; sources: IInstanceCreator<ISourceOptions, ISource, ISourceParamas>[]; taskRunners: IInstanceCreator<ITaskRunnerOptions, ITaskRunner, ITaskRunnerParams>[]; taskTriggers: IInstanceCreator<ITaskTriggerOptions, ITaskTrigger, ITaskTriggerParams>[]; }>

Defined in: src/plugin/plugin.ts:32

所有服务启动之前被调用。适合注册各类构建器，如消息源、技能、机器人。也可以注入自定义的路由，如果需要在实体注册和创建之后，http启动之前可以在beforeStart中实现。

Returns

Promise<{ bots: IInstanceCreator<IBotOptions, IBot, IBotParams>[]; skills: IInstanceCreator<ISkillOptions, ISkill, ISkillParams>[]; sources: IInstanceCreator<ISourceOptions, ISource, ISourceParamas>[]; taskRunners: IInstanceCreator<ITaskRunnerOptions, ITaskRunner, ITaskRunnerParams>[]; taskTriggers: IInstanceCreator<ITaskTriggerOptions, ITaskTrigger, ITaskTriggerParams>[]; }>

---

name

name: string

Defined in: src/plugin/plugin.ts:61

插件名称，需要跟package.json中的完全一致

---

needOnline

needOnline: boolean

Defined in: src/plugin/plugin.ts:57

是否必须使用在线配置的相关功能，如进行数据存储。

---

schema?

optional schema: Stringify

Defined in: src/plugin/plugin.ts:65

插件配置UI定义，如果不设置，则使用JSON编辑器编辑。

Methods

dispose()

dispose(): Promise<string>

Defined in: src/util/disposable.ts:2

Returns

Promise<string>

Inherited from

IDisposable.dispose