Package-level declarations

Types

Link copied to clipboard
interface Bot : CoroutineScope

一个 KOOK Bot。

Link copied to clipboard

Bot 使用的配置。

Link copied to clipboard
object BotFactory

构建 Bot 的工厂。

Link copied to clipboard

事件接收中因为事件无法反序列化而导致的错误。

Link copied to clipboard
fun interface EventProcessor

事件处理器函数。

Link copied to clipboard

一个异步式的 EventProcessor,是提供给 Java 的友好类型。 可直接使用 EventProcessors.async((event, raw) -> { ... }) 构建。

Link copied to clipboard

一个阻塞式的 EventProcessor,是提供给 Java 的友好类型。 可直接使用 EventProcessors.block((event, raw) -> { ... }) 构建。

Link copied to clipboard

Bot 连接成功后,当连接关闭时抛出的异常。

Link copied to clipboard

bot启动过程中、连接失败(比如多次重试仍无法连接)时抛出的异常。

Link copied to clipboard

Bot 中的事件处理器类型。

Link copied to clipboard

Bot 中订阅事件时的序列类型。

Link copied to clipboard
interface Ticket

Bot 所使用的部分权限"票据"。

Link copied to clipboard

以异步的形式实现 EventProcessor,是提供给 Java 的友好类型。 可直接使用 EventProcessors.async((event, raw) -> { ... }) 构建。

Link copied to clipboard

以阻塞的形式实现 EventProcessor,是提供给 Java 的友好类型。 可直接使用 EventProcessors.block((event, raw) -> { ... }) 构建。

Properties

Link copied to clipboard
actual const val DEFAULT_COMPRESS: Boolean = false

BotConfigurationBotConfiguration.isCompress 的默认值, 默认关闭,但是可以开启,通过 Frame.Binary.readToTextWithDeflated 的平台实现支持。

actual const val DEFAULT_COMPRESS: Boolean = true

BotConfigurationBotConfiguration.isCompress 的默认值, 默认开启,通过 Frame.Binary.readToTextWithDeflated 的平台实现支持。

actual const val DEFAULT_COMPRESS: Boolean = false

BotConfigurationBotConfiguration.isCompress 的默认值, 默认关闭且不保证支持。

Functions

Link copied to clipboard

构建一个异步式的 EventProcessor

构建一个处理目标类型 E 的异步式 EventProcessor

构建一个 Event.typetype 的 的异步式 EventProcessor

Link copied to clipboard

构建一个阻塞式的 EventProcessor

构建一个处理目标类型 E 的阻塞式 EventProcessor

构建一个 Event.typetype 的阻塞式 EventProcessor

Inherited functions

Link copied to clipboard
suspend fun Bot.alsoStart(): Bot

Start and return bot self.

Link copied to clipboard
suspend fun Bot.closeAndJoin()

Close bot and join.

Link copied to clipboard
Link copied to clipboard
inline fun <EX : EventExtra> Bot.processor(crossinline processor: suspend Event<EX>.(raw: String) -> Unit)

针对一个具体的 EventExtra 类型进行监听。

inline fun Bot.processor(type: Event.Type, crossinline processor: suspend Event<*>.(raw: String) -> Unit)

针对一个 Event.type 目标进行监听。

Link copied to clipboard
suspend fun KookApi<*>.requestBy(bot: Bot): HttpResponse

使用 BotKookApi 发起请求。

Link copied to clipboard
suspend fun <T : Any> KookApi<T>.requestDataBy(bot: Bot): T

使用 BotKookApi 发起请求。

Link copied to clipboard
suspend fun KookApi<*>.requestResultBy(bot: Bot): ApiResult

使用 BotKookApi 发起请求。

Link copied to clipboard
suspend fun KookApi<*>.requestTextBy(bot: Bot): String

使用 BotKookApi 发起请求。

Link copied to clipboard
suspend fun Bot.startAndJoin()

Start bot and join.

Link copied to clipboard
inline fun <EX : EventExtra> Bot.subscribe(subscribeSequence: SubscribeSequence = SubscribeSequence.NORMAL, crossinline processor: suspend Event<EX>.(raw: String) -> Unit)

订阅一个具体的 EventExtra 类型的事件。

inline fun Bot.subscribe(type: Event.Type, subscribeSequence: SubscribeSequence = SubscribeSequence.NORMAL, crossinline processor: suspend Event<*>.(raw: String) -> Unit)

订阅一个 Event.type 目标的事件。

Link copied to clipboard