OneBotApiResult

data class OneBotApiResult<T : Any>(val retcode: Int, val status: String? = null, val data: T? = null)(source)

响应

OneBot 会对每个 API 调用返回一个 JSON 响应(除非是 HTTP 状态码不为 200 的情况),响应中的 data 字段包含 API 调用返回的数据内容。 在后面的 API 描述中,将只给出 data 字段的内容,放在「响应数据」小标题下,而不再赘述 statusretcode 字段。

OneBotApiResult 中,为了区分失败的结果和成功但结果为 null 的情况, 那个本身成功结果就应该为 null 的 API 应当将结果 T 定义为 Unit 类型以此代替 null。 同时在反序列化时,如果 retcode == RETCODE_SUCCESS 并且结果的预期类型是一个 Unit,则直接填充它。 建议

Constructors

Link copied to clipboard
constructor(retcode: Int, status: String? = null, data: T? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val data: T? = null

不为 null 代表结果成功。

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

当可以为其附加‘原始信息’(例如原始的JSON字符串) 时,在反序列化完成后可以为其赋值。

Link copied to clipboard
Link copied to clipboard
val status: String? = null