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

ApiResult

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

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

Constructors

fun ApiResult(code: Int, message: String, data: JsonElement)

Functions

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

open override fun hashCode(): Int

fun <T> parseData(json: Json, deserializationStrategy: DeserializationStrategy<out T>): T

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

parseDataOrThrow

fun <T> parseDataOrThrow(json: Json, deserializationStrategy: DeserializationStrategy<out T>): T

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

open override fun toString(): String

Properties

val data: JsonElement

val isSuccess: Boolean

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

val message: String

var rateLimit: RateLimit

当前api响应值的速率限制信息。会在当前类实例化之后再进行初始化。