simbot-component-qq-guild-stdlib/love.forte.simbot.qguild/Bot

Bot

interface Bot : BasePlatformBot, CoroutineScope(source)

一个 QQ频道Bot。

在Java中，可以通过扩展工具类 Bots.xxx 得到更多兼容函数。

Author

ForteScarlet

Types

interface Client

Bot的连接信息。一般来讲代表一个ws连接。

data class Ticket(val appId: String, val secret: String, val token: String)

Functions

abstract suspend fun cancel(reason: Throwable? = null): Boolean

终止当前BOT。

abstract suspend fun join()

挂起直到此bot被 cancel. 如果已经 cancel, 则不会挂起。

abstract suspend fun me(): User

通过 api GetBotInfoApi 查询bot自身信息。

registerPreProcessor

abstract override fun registerPreProcessor(processor: EventProcessor): DisposableHandle

添加一个事件预处理器。

registerProcessor

abstract override fun registerProcessor(processor: EventProcessor): DisposableHandle

添加一个事件处理器。

registerProcessor

inline fun <E : Signal.Dispatch> Bot.registerProcessor(crossinline block: suspend E.(raw: String) -> Unit): DisposableHandle

用当前 Bot 订阅一个指定类型 E 的事件。

suspend fun <R> Bot.request(api: QQGuildApi<R>): R

直接通过bot进行请求。

suspend fun <R> Bot.requestRaw(api: QQGuildApi<R>): String

直接通过bot进行请求。

abstract suspend fun start(): Boolean

abstract suspend fun start(gateway: GatewayInfo): Boolean

启动当前BOT。如果已经存在 client, 则会关闭已存连接并重新连接。

Properties

abstract val apiClient: HttpClient

bot用于api请求的 HttpClient.

abstract val apiDecoder: Json

用于api请求并反序列化的 Json

abstract val apiServer: Url

当前bot所使用的

abstract val client: Bot.Client?

此Bot中的连接信息。

abstract val configuration: BotConfiguration

Bot当前的配置信息。

coroutineContext

abstract override val coroutineContext: CoroutineContext

abstract val shard: Shard

此bot使用的 shard 信息。

abstract val ticket: Bot.Ticket

当前bot的 Ticket.