love.forte.simbot.kook.api

ApiRateLimitException

open class ApiRateLimitException : KookRuntimeException

Kook 超速限制异常。

ApiRateLimits

object ApiRateLimits

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

ApiResult

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

对 Kook Api标准响应数据的封装。

ApiResultType

annotation class ApiResultType

BaseKookApiRequest

abstract class BaseKookApiRequest<T> : KookApiRequest<T>

BaseKookApiRequestKey

abstract class BaseKookApiRequestKey(paths: String)

用于 KookApiRequest 实现类的伴生对象进行实现的辅助抽象类，用于提供 apiPathList等。

Gateway

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

api GatewayRequest 的响应体。

GatewayRequest

sealed class GatewayRequest : KookGetRequest<Gateway>

Kook v3-api的 gateway 获取接口的请求参数。

KookApiException

open class KookApiException(val code: Int, val msg: String?, cause: Throwable? = null) : SimbotIllegalStateException

与 Kook api 相关的异常。

KookApiRequest

abstract class KookApiRequest<T>

代表、包装了一个 Kook api的请求。

KookApiResult

object KookApiResult

Kook Api的响应值标准格式。

KookGetRequest

abstract class KookGetRequest<T> : BaseKookApiRequest<T>

使用 Get 请求的 KookApiRequest 基础实现。

KookPostRequest

abstract class KookPostRequest<T>(cacheBody: Boolean = true) : BaseKookApiRequest<T>

使用 Get 请求的 KookApiRequest 基础实现。

KookRuntimeException

open class KookRuntimeException : SimbotRuntimeException

Kook 相关异常。

PageRequestParameters

class PageRequestParameters(var page: Int = -1, var pageSize: Int = -1)

用于KookAPI中分页查询的参数。

RateLimit

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

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

appendIfNotnull

inline fun <T> ParametersBuilder.appendIfNotnull(name: String, value: T?, toStringBlock: (T) -> String = { it.toString() })

当目标值 value 不为null时拼接。

appendIfNotnullAnd

inline fun <T> ParametersBuilder.appendIfNotnullAnd(name: String, value: T?, check: (T) -> Boolean, toStringBlock: (T) -> String = { it.toString() })

当目标值 value 不为null并且通过 check 检测的时候。

appendTo

fun PageRequestParameters.appendTo(builder: ParametersBuilder)

err

inline fun CloseReason?.err(e: Throwable? = null): Nothing

resume

fun GatewayRequest.resume(sn: Long, sessionId: String): GatewayRequest.Resume

isRateGlobal

val HttpResponse.isRateGlobal: Boolean

HttpResponse 中是否存在 ApiRateLimits.RATE_LIMIT_GLOBAL_HEAD。

rateBucket

val HttpResponse.rateBucket: String?

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

rateLimit

val HttpResponse.rateLimit: Int?

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

rateRemaining

val HttpResponse.rateRemaining: Int?

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

rateReset

val HttpResponse.rateReset: Int?

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

Package-level declarations

Types

Functions

Properties