simbot-component-kook-stdlib/love.forte.simbot.kook/KookBotConfiguration

KookBotConfiguration

class KookBotConfiguration

KookBot 需要使用的配置类。

配置类不应在bot构建完成之后再做修改。

Author

ForteScarlet

Constructors

KookBotConfiguration

fun KookBotConfiguration()

Types

Companion

object Companion

TimeoutConfiguration

data class TimeoutConfiguration(var connectTimeoutMillis: Long? = null, var requestTimeoutMillis: Long? = null, var socketTimeoutMillis: Long? = null)

api请求的统一超时时间配置。

Functions

disableEventProcessAsync

fun disableEventProcessAsync()

禁用事件的异步调度。即 set isEventProcessAsync = false

disableTimeout

fun disableTimeout()

禁用超时配置。

httpClientConfig

fun httpClientConfig(block: HttpClientConfig<*>.() -> Unit)

配置bot内部要使用的httpclient。

preEventProcessor

fun preEventProcessor(block: suspend (bot: KookBot, sessionId: String) -> Unit)

在执行 KookBot.start 建立连接成功后、进行事件处理之前执行此函数。

Properties

clientEngine

var clientEngine: HttpClientEngine? = null

配置bot内部要使用的client Engine。

clientEngineFactory

var clientEngineFactory: HttpClientEngineFactory<*>? = null

配置bot内部要使用的client Engine factory。

connectTimeoutMillis

var connectTimeoutMillis: Long?

api请求的连接超时时间。

coroutineContext

var coroutineContext: CoroutineContext

为bot提供一个 CoroutineContext. 如果其中存在 kotlinx.coroutines.Job, 则会作为parent job。

decoder

var decoder: Json

Bot用于解析api请求或其他用途的解析器。

httpClientConfig

var httpClientConfig: HttpClientConfig<*>.() -> Unit

配置bot内部要使用的httpclient。

isCompress

var isCompress: Boolean = true

设置bot进行连接的时候使用要使用压缩数据。

isEventProcessAsync

var isEventProcessAsync: Boolean = true

在进行事件处理时是否进行异步处理（使用 launch { ... } 调度）。

preEventProcessor

var preEventProcessor: suspend (bot: KookBot, sessionId: String) -> Unit

在执行 KookBot.start 建立连接成功后、进行事件处理之前执行此函数。

requestTimeoutMillis

var requestTimeoutMillis: Long?

api请求的请求超时时间。

socketTimeoutMillis

var socketTimeoutMillis: Long?

api请求的请求超时时间。

timeout

var timeout: KookBotConfiguration.TimeoutConfiguration?

api请求的超时配置。如果为null则不会在 httpClient 中安装 io.ktor.client.plugins.HttpTimeout。

wsConnectTimeout

var wsConnectTimeout: Long

ws连接超时时间。默认为 DEFAULT_WS_CONNECT_TIMEOUT.

Extensions

timeout

inline fun KookBotConfiguration.timeout(init: Boolean = true, block: KookBotConfiguration.TimeoutConfiguration.() -> Unit)

配置 KookBotConfiguration.timeout。