simbot-component-qq-guild-api/love.forte.simbot.qguild.api/QQGuildApi

QQGuildApi

abstract class QQGuildApi<out R> : PlatformQQGuildApi<R> (source)

表示为一个QQ频道的API。

通过 doRequest 发起一次请求。

日志

QQGuildApi 在进行请求的过程中会通过名称 love.forte.simbot.qguild.api 输出 DEBUG 日志，其中：

[   GET /foo/bar] =====> api.xxx.com, body: xxx

向右箭头的日志代表 request 相关的信息，

[   GET /foo/bar] <===== status: xxx, body: xxx

向左的日志则代表 response 相关的信息。

如果希望关闭日志中 request method 的染色，添加JVM参数

-Dsimbot.qguild.api.logger.color.enable=false

Inheritors

QQGuildApiWithoutResult

Constructors

QQGuildApi

constructor()

Types

Companion

object Companion

Functions

doRequest

open suspend override fun doRequest(client: HttpClient, server: Url, token: String, decoder: StringFormat): R

使用此api发起一次请求，并得到预期中的结果。

doRequestRaw

open suspend override fun doRequestRaw(client: HttpClient, server: Url, token: String): String

使用此api发起一次请求，并得到响应结果的字符串。

post

open fun post(resp: @UnsafeVariance R)

当通过 doRequest 得到成功结果后进行的操作。

request

suspend fun <R> QQGuildApi<R>.request(client: HttpClient = QQGuildApi.DefaultHttpClient, server: Url, token: String, decoder: StringFormat = QQGuildApi.DefaultJsonDecoder): R

通过提供的参数，对此api进行请求并得到最终结果。

requestForResponse

protected suspend fun requestForResponse(client: HttpClient, server: Url, token: String, json: Json = DefaultJsonDecoder): HttpResponse

requestForText

protected inline suspend fun requestForText(client: HttpClient, server: Url, token: String, useResp: (HttpResponse) -> Unit = {}): String

通过 requestForResponse 得到响应，读取为文本并输出debug日志后返回。不会进行校验。

requestRaw

suspend fun QQGuildApi<*>.requestRaw(client: HttpClient = QQGuildApi.DefaultHttpClient, server: Url, token: String): String

通过提供的参数，对此api进行请求并得到最终结果。

route

abstract fun route(builder: RouteInfoBuilder)

此请求对应的api路由路径以及路径参数。例如：/guild/list

Properties

body

abstract val body: Any?

此次请求所发送的数据。为null则代表没有参数。

method

abstract val method: HttpMethod

此api请求方式

resultDeserializer

abstract val resultDeserializer: DeserializationStrategy<R>

得到响应值的反序列化器.