Skip to content

Bot

机器人 (Bot) 是适配器的核心,它将不同平台的 API 封装成统一的格式供 Koishi 使用。而不同的适配器也可以自行扩展 Bot 实例上的属性和方法。

Instance Properties

bot.adapter

当前 Bot 所在的 Adapter 实例。

bot.config

  • Type: object

构造 Bot 实例时所使用的配置项。

bot.ctx

当前 Bot 所在的 Context 实例。

bot.internal

  • Type: object

当前机器人的 内部接口

bot.platform

  • Type: string

当前 Bot平台名称

bot.selfId

  • Type: string

当前 Bot 的平台账号。

bot.status

当前 Bot 的登录状态。

bot.user

当前 Bot 的用户信息。

bot.start()

  • 返回值: Promise<void>

启动机器人。这个方法会在插件被加载时自动被调用,通常你不需要手动调用它。

bot.stop()

  • 返回值: Promise<void>

停止机器人的运行,但不移除该实例。你可以后续通过 bot.start() 重新启动机器人。

这个方法会在插件被卸载时自动被调用,通常你不需要手动调用它。

bot.dispatch(session)

Dispatch a session event.

bot.session(event?)

创建一个新的会话实例。

bot.online()

修改机器人的状态为在线。

bot.offline(error?)

  • error: Error 错误信息

修改机器人的状态为离线,并记录错误信息。

通用 API

通用 API 由适配器实现。它们会在相应的资源页面中介绍。