simbot-component-onebot-v11-core/love.forte.simbot.component.onebot.v11.core.api/CustomOneBotApiBuilder

CustomOneBotApiBuilder

interface CustomOneBotApiBuilder<T : Any>(source)

一个用于动态构建定制化 OneBot API 的构建器， 可以在不直接实现 BasicOneBotApi 的情况下以 DSL 或链式 API 的形式构建一个 BasicOneBotApi。

Since

1.9.0

Author

ForteScarlet

Properties

Link copied to clipboard
abstract val action: String

OneBot API 的动作/行为名称。

Link copied to clipboard
abstract var body: Any?

请求体，在非 Get 请求时使用。

Link copied to clipboard
abstract var deserializer: DynamicOneBotApiDeserializer<T>?

响应结果的反序列化器。

Link copied to clipboard
abstract val method: HttpMethod

API 请求方式。默认为 HttpMethod.Post.

Functions

Link copied to clipboard
open fun body(body: Any?): CustomOneBotApiBuilder<T>

提供请求体。

Link copied to clipboard
abstract fun build(): CustomOneBotApi<T>
Link copied to clipboard
abstract fun deserializer(deserializationStrategy: DeserializationStrategy<OneBotApiResult<T>>): CustomOneBotApiBuilder<T>
open fun deserializer(deserializer: DynamicOneBotApiDeserializer<T>): CustomOneBotApiBuilder<T>

提供一个对 API 响应的文本内容进行反序列化的函数。

Inherited functions

Link copied to clipboard
fun <T : Any> CustomOneBotApiBuilder<T>.dataDeserializer(dataDeserializer: KSerializer<T>): CustomOneBotApiBuilder<T>

提供一个 OneBotApiResult.data 的类型 T 的序列化器， 来作为 CustomOneBotApiBuilder 的反序列化方案。