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

ApiResult

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

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

ApiResult 由内部反序列化器构造并组装，不应被外界实例化。

Constructors

constructor(code: Int, message: String, data: JsonElement = EMPTY_OBJECT)

Types

object Companion

Properties

错误码，0代表成功，非0代表失败，具体的错误码参见错误码一览

val data: JsonElement

mixed, 具体的数据

lateinit var httpStatus: HttpStatusCode

此API的HTTP响应状态码

val httpStatusCode: Int

http响应状态码

httpStatusDescription

val httpStatusDescription: String

http响应状态描述

val isHttpSuccess: Boolean

判断 httpStatus 是否成功。

val isSuccess: Boolean

此接口的响应码是否为成功的响应码.

val message: String

错误消息，具体的返回消息会根据Accept-Language来返回。

lateinit var rateLimit: RateLimit

当前api响应值的速率限制信息。

lateinit var raw: String

当前 result 反序列化前的原始JSON字符串。

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

fun <T> parseData(json: Json = KookApi.DEFAULT_JSON, deserializationStrategy: DeserializationStrategy<T>): T

提供解析参数来使用当前result中的data内容解析为目标结果。不会有任何判断，

parseDataOrThrow

fun <T> parseDataOrThrow(json: Json = KookApi.DEFAULT_JSON, deserializationStrategy: DeserializationStrategy<T>): T

当 code 为成功的时候解析 data 数据, 如果 code 不为成功(KookApiResults.SUCCESS_CODE), 则抛出 ApiResultException 异常。

open override fun toString(): String