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

ConfigurableBotConfiguration

class ConfigurableBotConfiguration : BotConfiguration, IntentsAppender(source)

对于一个Bot的配置信息。如果在配置bot之后对内容进行后续修改，可能会影响到当前bot的使用。

Constructors

constructor()

Types

Companion

object Companion

Properties

apiClientAdditionalConfiguration

open override var apiClientAdditionalConfiguration: ConfigurerFunction<HttpClientConfig<*>>

构建 API 客户端时追加的 Ktor 配置。

apiClientEngine

open override var apiClientEngine: HttpClientEngine?

用于API请求的 HttpClient 所使用的引擎。

apiClientEngineFactory

open override var apiClientEngineFactory: HttpClientEngineFactory<*>?

用于API请求的 HttpClient 所使用的引擎工厂。

apiDecoder

open override var apiDecoder: Json

用于API请求结果反序列化的 Json.

apiHttpConnectTimeoutMillis

open override var apiHttpConnectTimeoutMillis: Long?

API请求中的超时请求配置。

apiHttpRequestTimeoutMillis

open override var apiHttpRequestTimeoutMillis: Long?

API请求中的超时请求配置。

apiHttpSocketTimeoutMillis

open override var apiHttpSocketTimeoutMillis: Long?

API请求中的超时请求配置。

clientProperties

open override var clientProperties: Map<String, String>

用作 Signal.Identify.Data.properties 中的参数。

contentAsMarkdown

open override val contentAsMarkdown: MutableMap<MessageDestination, Boolean>

控制各消息目的地是否将普通内容作为 Markdown 发送。

coroutineContext

open override var coroutineContext: CoroutineContext

Context.

disableWs

open override var disableWs: Boolean

是否禁用 ws 连接。如果你打算使用 webhook，则设置为 true, 届时在启动 bot 时不会再连接 ws 服务。

intents

open override var intents: Intents

bot需要订阅的事件 Intents.

intentsValue

open override var intentsValue: Int

bot需要订阅的事件 Intents （的整型字面值）.

serverUrl

open override var serverUrl: Url

请求的服务器地址。默认为 QQGuild.URL. 即正式地址。

shard

open override var shard: Shard

此bot建立的链接所使用的 shard。默认情况下使用 Shard.FULL.

wsClientEngine

open override var wsClientEngine: HttpClientEngine?

用于ws连接的 HttpClient 所使用的引擎。

wsClientEngineFactory

open override var wsClientEngineFactory: HttpClientEngineFactory<*>?

用于ws连接的 HttpClient 所使用的引擎工厂。

Functions

addIntents

@JvmName(name = "addIntents")

fun addIntents(intents: Intents): ConfigurableBotConfiguration

向 intents 中添加一个 Intents 值。

apiClientAdditionalConfiguration

fun apiClientAdditionalConfiguration(configurer: ConfigurerFunction<HttpClientConfig<*>>)

向 apiClientAdditionalConfiguration 追加配置逻辑。

appendIntents

open override fun appendIntents(intents: Intents)

contentAsMarkdownAll

fun contentAsMarkdownAll(value: Boolean = true): ConfigurableBotConfiguration

为全部消息目的地设置普通内容的 Markdown 发送行为。

useSandboxServerUrl

fun useSandboxServerUrl()

使 BotConfiguration.serverUrl 为 QQGuild.SANDBOX_URL