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

OneBotApi

interface OneBotApi<T : Any> : BasicOneBotApi<T> (source)

针对一个 OneBot API 的定义实现， 在 BasicOneBotApi 的基础上，使用基于 kotlinx-serialization 的反序列化器来实现 deserialize。

API调用需要指定 action 和 body.

Author

ForteScarlet

Inheritors

Types

Link copied to clipboard
object Actions

Properties

Link copied to clipboard
abstract val apiResultDeserializer: DeserializationStrategy<OneBotApiResult<T>>

预期结果 OneBotApiResult 类型的反序列化器。

Link copied to clipboard
open override val method: HttpMethod

此 API 的请求方式。 OneBot协议中的标准API通常均为 POST， 但是一些额外的扩展或自定义API可能是 GET 或其他方式。

Link copied to clipboard
abstract val resultDeserializer: DeserializationStrategy<T>

预期结果的反序列化器。

Inherited properties

Link copied to clipboard
abstract val action: String

API 的 action（要进行的动作），会通过 resolveUrlAction 附加在 url 中。 可以重写它来改变此逻辑。

Link copied to clipboard
abstract val body: Any?

API的请求体。

Functions

Link copied to clipboard
open override fun deserialize(responseBody: String): OneBotApiResult<T>

将 API 返回的 JSON 字符串反序列化为 OneBotApiResult。

Inherited functions

Link copied to clipboard
suspend fun BasicOneBotApi<*>.request(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null): HttpResponse
suspend fun BasicOneBotApi<*>.request(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null): HttpResponse

对 this 发起一次请求，并得到相应的 HttpResponse 响应。

Link copied to clipboard
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestAsync(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, scope: CoroutineScope? = null): CompletableFuture<out HttpResponse>
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestAsync(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, scope: CoroutineScope? = null): CompletableFuture<out HttpResponse>

异步地请求 BasicOneBotApi.

Link copied to clipboard
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestBlocking(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null): HttpResponse
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestBlocking(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null): HttpResponse

阻塞地请求 BasicOneBotApi.

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

使用 bot 对 this 发起一次请求， 并得到相应的 HttpResponse 响应。

Link copied to clipboard
@Api4J
fun BasicOneBotApi<*>.requestByAsync(bot: OneBotBot): CompletableFuture<out HttpResponse>

使用 bot 对 this 发起一次异步地请求，

Link copied to clipboard
@Api4J
fun BasicOneBotApi<*>.requestByBlocking(bot: OneBotBot): HttpResponse

使用 bot 对 this 发起一次阻塞地请求，

Link copied to clipboard
@Api4J
fun BasicOneBotApi<*>.requestByReserve(bot: OneBotBot): SuspendReserve<HttpResponse>

使用 bot 对 this 发起一次预处理地请求，

Link copied to clipboard
suspend fun <T : Any> BasicOneBotApi<T>.requestData(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): T

对 this 发起一次请求，并得到响应体的 T 类型结果。

suspend fun <T : Any> BasicOneBotApi<T>.requestData(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): T

对 this 发起一次请求，并得到响应体的 T 结果。

Link copied to clipboard
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestDataAsync(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): CompletableFuture<out T>
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestDataAsync(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): CompletableFuture<out T>

异步地请求 BasicOneBotApi.

Link copied to clipboard
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestDataBlocking(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): T
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestDataBlocking(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): T

阻塞地请求 BasicOneBotApi.

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

使用 bot 对 this 发起一次请求， 并得到相应的 T 响应。

Link copied to clipboard
@Api4J
fun <T : Any> BasicOneBotApi<T>.requestDataByAsync(bot: OneBotBot): CompletableFuture<out T>

使用 bot 对 this 发起一次异步地请求，

Link copied to clipboard
@Api4J
fun <T : Any> BasicOneBotApi<T>.requestDataByBlocking(bot: OneBotBot): T

使用 bot 对 this 发起一次阻塞地请求，

Link copied to clipboard
@Api4J
fun <T : Any> BasicOneBotApi<T>.requestDataByReserve(bot: OneBotBot): SuspendReserve<T>

使用 bot 对 this 发起一次预处理地请求，

Link copied to clipboard
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestDataReserve(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): SuspendReserve<T>
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestDataReserve(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): SuspendReserve<T>

异步地请求 BasicOneBotApi.

Link copied to clipboard
suspend fun BasicOneBotApi<*>.requestRaw(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8): String
suspend fun BasicOneBotApi<*>.requestRaw(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8): String

对 this 发起一次请求，并得到响应体的字符串内容。

Link copied to clipboard
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestRawAsync(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null): CompletableFuture<out String>
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestRawAsync(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null): CompletableFuture<out String>

异步地请求 BasicOneBotApi.

Link copied to clipboard
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestRawBlocking(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8): String
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestRawBlocking(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8): String

阻塞地请求 BasicOneBotApi.

Link copied to clipboard
suspend fun BasicOneBotApi<*>.requestRawBy(bot: OneBotBot): String

使用 bot 对 this 发起一次请求， 并得到相应的 String 响应。

Link copied to clipboard
@Api4J
fun BasicOneBotApi<*>.requestRawByAsync(bot: OneBotBot): CompletableFuture<out String>

使用 bot 对 this 发起一次异步地请求，

Link copied to clipboard
@Api4J
fun BasicOneBotApi<*>.requestRawByBlocking(bot: OneBotBot): String

使用 bot 对 this 发起一次阻塞地请求，

Link copied to clipboard
@Api4J
fun BasicOneBotApi<*>.requestRawByReserve(bot: OneBotBot): SuspendReserve<String>

使用 bot 对 this 发起一次预处理地请求，

Link copied to clipboard
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestRawReserve(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null): SuspendReserve<String>
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestRawReserve(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null): SuspendReserve<String>

异步地请求 BasicOneBotApi.

Link copied to clipboard
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestReserve(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, scope: CoroutineScope? = null): SuspendReserve<HttpResponse>
@Api4J
@JvmOverloads
fun BasicOneBotApi<*>.requestReserve(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, scope: CoroutineScope? = null): SuspendReserve<HttpResponse>

异步地请求 BasicOneBotApi.

Link copied to clipboard
suspend fun <T : Any> BasicOneBotApi<T>.requestResult(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): OneBotApiResult<T>
suspend fun <T : Any> BasicOneBotApi<T>.requestResult(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): OneBotApiResult<T>

对 this 发起一次请求，并得到响应体的 OneBotApiResult 结果。

Link copied to clipboard
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestResultAsync(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): CompletableFuture<out OneBotApiResult<T>>
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestResultAsync(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): CompletableFuture<out OneBotApiResult<T>>

异步地请求 BasicOneBotApi.

Link copied to clipboard
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestResultBlocking(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): OneBotApiResult<T>
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestResultBlocking(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, decoder: Json = OneBot11.DefaultJson): OneBotApiResult<T>

阻塞地请求 BasicOneBotApi.

Link copied to clipboard
suspend fun <T : Any> BasicOneBotApi<T>.requestResultBy(bot: OneBotBot): OneBotApiResult<T>

使用 bot 对 this 发起一次请求， 并得到相应的 OneBotApiResult 响应。

Link copied to clipboard
@Api4J
fun <T : Any> BasicOneBotApi<T>.requestResultByAsync(bot: OneBotBot): CompletableFuture<out OneBotApiResult<T>>

使用 bot 对 this 发起一次异步地请求，

Link copied to clipboard
@Api4J
fun <T : Any> BasicOneBotApi<T>.requestResultByBlocking(bot: OneBotBot): OneBotApiResult<T>

使用 bot 对 this 发起一次阻塞地请求，

Link copied to clipboard
@Api4J
fun <T : Any> BasicOneBotApi<T>.requestResultByReserve(bot: OneBotBot): SuspendReserve<OneBotApiResult<T>>

使用 bot 对 this 发起一次预处理地请求，

Link copied to clipboard
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestResultReserve(client: HttpClient, host: Url, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): SuspendReserve<OneBotApiResult<T>>
@Api4J
@JvmOverloads
fun <T : Any> BasicOneBotApi<T>.requestResultReserve(client: HttpClient, host: String, accessToken: String? = null, actionSuffixes: Collection<String>? = null, charset: Charset = Charsets.UTF_8, scope: CoroutineScope? = null, decoder: Json = OneBot11.DefaultJson): SuspendReserve<OneBotApiResult<T>>

异步地请求 BasicOneBotApi.

Link copied to clipboard
Link copied to clipboard
open fun resolveUrlAction(urlBuilder: URLBuilder, actionSuffixes: Collection<String>?)

根据 action 和可能额外要求的 actionSuffixes 构建一个完整的请求地址。

Link copied to clipboard
open fun resolveUrlExtensions(urlBuilder: URLBuilder)

对 urlBuilder 进行一些额外的处理，例如当method为GET时为其添加查询参数。 主要面向额外扩展的自定义实现来重写此方法。