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

Package-level declarations

Types

ApiRateLimitException

open class ApiRateLimitException : KookException

Kook 超速限制异常。

ApiRateLimits

object ApiRateLimits

超速限制中的部分常量信息。

ApiResponseException

class ApiResponseException(val response: HttpResponse, message: String? = null, cause: Throwable? = null) : KookException

当API请求得到失败响应得到此异常。

ApiResult

@Serializable

class ApiResult @ApiResultType constructor(val code: Int, val message: String, val data: JsonElement = EMPTY_OBJECT)

对 KOOK API 标准响应数据的封装。

ApiResultException

class ApiResultException(val result: ApiResult, message: String? = null, cause: Throwable? = null) : KookException

当API请求的状态码成功，但是 ApiResult 表现结果为失败时。

ApiResultType

annotation class ApiResultType

标记为一个作为 KOOK API 请求而返回的类型，应由 KOOK API 请求结果进行反序列化实现而不可直接构造。

BaseKookApi

abstract class BaseKookApi<T : Any> : KookApi<T>

KookApi 的进一步抽象实现，简化针对 KookApi.url 的构造过程。

Gateway

@Serializable

data class Gateway @ApiResultType constructor(val url: String)

通过 GetGatewayApi 得到的网关信息。

GetGatewayApi

sealed class GetGatewayApi(isCompress: Boolean) : KookGetApi<Gateway>

获取网关连接地址。

KookApi

interface KookApi<T : Any> : ApiDefinition<T>

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

KookApiResults

object KookApiResults

Kook Api的响应值标准格式。

KookGetApi

abstract class KookGetApi<T : Any> : BaseKookApi<T>

使用 GET 进行请求的 KookApi 基础抽象。

KookPostApi

abstract class KookPostApi<T : Any> : BaseKookApi<T>

使用 POST 进行请求的 KookApi 基础抽象。

ListData

@Serializable

class ListData<out T>(val items: List<T> = emptyList(), val meta: ListMeta, val sort: Map<String, Int> = emptyMap()) : ListDataResponse<T, Map<String, Int>> , Iterable<T>

ListData 将 sort 类型直接视为 Map 进行解析。

ListDataResponse

abstract class ListDataResponse<out T, SORT>

当响应体中的 data 为列表类型时，其有特殊的数据格式:

ListMeta

@Serializable

data class ListMeta(val page: Int, val pageTotal: Int, val pageSize: Int, val total: Int)

当返回值为列表时的分页响应元数据。

RateLimit

@Serializable

data class RateLimit(val limit: Long, val remaining: Long, val reset: Long, val bucket: String?, val isGlobalLimit: Boolean)

速率限制请求头中的数据体。

Inherited properties

isRateGlobal

val HttpResponse.isRateGlobal: Boolean

HttpResponse 中是否存在 ApiRateLimits.RATE_LIMIT_GLOBAL_HEAD。

val Headers.isRateGlobal: Boolean

Headers 中是否存在 ApiRateLimits.RATE_LIMIT_GLOBAL_HEAD。

rateBucket

val HttpResponse.rateBucket: String?

尝试获取 HttpResponse 中的 ApiRateLimits.RATE_LIMIT_BUCKET_HEAD 信息。

val Headers.rateBucket: String?

尝试获取 Headers 中的 ApiRateLimits.RATE_LIMIT_BUCKET_HEAD 信息。

rateLimit

val HttpResponse.rateLimit: Long?

尝试获取 HttpResponse 中的 ApiRateLimits.RATE_LIMIT_LIMIT_HEAD 信息。

val Headers.rateLimit: Long?

尝试获取 Headers 中的 ApiRateLimits.RATE_LIMIT_LIMIT_HEAD 信息。

rateRemaining

val HttpResponse.rateRemaining: Long?

尝试获取 HttpResponse 中的 ApiRateLimits.RATE_LIMIT_REMAINING_HEAD 信息。

val Headers.rateRemaining: Long?

尝试获取 Headers 中的 ApiRateLimits.RATE_LIMIT_REMAINING_HEAD 信息。

rateReset

val HttpResponse.rateReset: Long?

尝试获取 HttpResponse 中的 ApiRateLimits.RATE_LIMIT_RESET_HEAD 信息。

val Headers.rateReset: Long?

尝试获取 Headers 中的 ApiRateLimits.RATE_LIMIT_RESET_HEAD 信息。

Functions

createHttpClient

fun createHttpClient(): HttpClient

直接构建一个 HttpClient. 需要环境中存在可用的引擎。

@JvmOverloads

fun createHttpClient(engine: HttpClientEngine, config: Consumer<HttpClientConfig<*>>? = null): HttpClient

构建一个 HttpClient.

@JvmOverloads

fun <T : HttpClientEngineConfig> createHttpClient(engineFactory: HttpClientEngineFactory<T>, config: Consumer<HttpClientConfig<T>>? = null): HttpClient

直接构建一个 HttpClient.

Inherited functions

request

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

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

requestAsync

@Api4J

@JvmOverloads

fun KookApi<*>.requestAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<HttpResponse>

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

requestBlocking

@Api4J

fun KookApi<*>.requestBlocking(client: HttpClient, authorization: String): HttpResponse

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

requestData

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

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

requestDataAsync

@Api4J

@JvmOverloads

fun <T : Any> KookApi<T>.requestDataAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<T>

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

requestDataBlocking

@Api4J

fun <T : Any> KookApi<T>.requestDataBlocking(client: HttpClient, authorization: String): T

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

requestDataReserve

@Api4J

@JvmOverloads

fun <T : Any> KookApi<T>.requestDataReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<T>

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

requestReserve

@Api4J

@JvmOverloads

fun KookApi<*>.requestReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<HttpResponse>

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

requestResult

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

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

requestResultAsync

@Api4J

@JvmOverloads

fun KookApi<*>.requestResultAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<ApiResult>

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

requestResultBlocking

@Api4J

fun KookApi<*>.requestResultBlocking(client: HttpClient, authorization: String): ApiResult

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

requestResultReserve

@Api4J

@JvmOverloads

fun KookApi<*>.requestResultReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<ApiResult>

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

requestText

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

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

requestTextAsync

@Api4J

@JvmOverloads

fun KookApi<*>.requestTextAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<String>

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

requestTextBlocking

@Api4J

fun KookApi<*>.requestTextBlocking(client: HttpClient, authorization: String): String

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

requestTextReserve

@Api4J

@JvmOverloads

fun KookApi<*>.requestTextReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<String>

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