simbot-component-kook-api/love.forte.simbot.kook.api/KookApi

KookApi

interface KookApi<T : Any> : ApiDefinition<T> (source)

一个用于表示 KOOK API 封装的抽象类。

KookApi 面向 Ktor 并基于 kotlinx.serialization 进行反序列化。

Author

ForteScarlet

Parameters

T

此API预期的响应结果数据类型

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract override val body: Any?

此次请求所发送的Body数据。为null则代表没有参数。

Link copied to clipboard
abstract override val headers: Headers

本次请求提供的请求头。

Link copied to clipboard
abstract override val method: HttpMethod

此请求使用的 HttpMethod。

Link copied to clipboard
abstract override val resultDeserializationStrategy: DeserializationStrategy<T>

预期结果类型的反序列化策略。

Link copied to clipboard
abstract override val url: Url

此请求最终的url。

Inherited functions

Link copied to clipboard
suspend fun KookApi<*>.request(client: HttpClient, authorization: String): HttpResponse

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult。

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<HttpResponse>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult。

Link copied to clipboard
@Api4J
fun KookApi<*>.requestBlocking(client: HttpClient, authorization: String): HttpResponse

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult。

Link copied to clipboard
suspend fun <T : Any> KookApi<T>.requestData(client: HttpClient, authorization: String): T

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个具体结果。

Link copied to clipboard
@Api4J
@JvmOverloads
fun <T : Any> KookApi<T>.requestDataAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<T>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个具体结果。

Link copied to clipboard
@Api4J
fun <T : Any> KookApi<T>.requestDataBlocking(client: HttpClient, authorization: String): T

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个具体结果。

Link copied to clipboard
@Api4J
@JvmOverloads
fun <T : Any> KookApi<T>.requestDataReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<T>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个具体结果。

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<HttpResponse>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult。

Link copied to clipboard
suspend fun KookApi<*>.requestResult(client: HttpClient, authorization: String): ApiResult

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult 结果。

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestResultAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<ApiResult>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult 结果。

Link copied to clipboard
@Api4J
fun KookApi<*>.requestResultBlocking(client: HttpClient, authorization: String): ApiResult

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult 结果。

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestResultReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<ApiResult>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult 结果。

Link copied to clipboard
suspend fun KookApi<*>.requestText(client: HttpClient, authorization: String): String

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个结果字符串。

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestTextAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<String>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个结果字符串。

Link copied to clipboard
@Api4J
fun KookApi<*>.requestTextBlocking(client: HttpClient, authorization: String): String

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个结果字符串。

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestTextReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<String>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个结果字符串。