simbot-component-qq-guild-api/love.forte.simbot.qguild.api.channel.schedules/GetScheduleListApi

GetScheduleListApi

class GetScheduleListApi : GetQQGuildApi<List<Schedule>> (source)

获取频道日程列表

用于获取 channel_id 指定的子频道中当天的日程列表。

若带了参数 since，则返回在 since 对应当天的日程列表；若未带参数 since，则默认返回今天的日程列表。

Author

ForteScarlet

Types

object Factory : SimpleGetApiDescription

Functions

open suspend override fun doRequest(client: HttpClient, server: Url, token: String, decoder: StringFormat): List<Schedule>

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

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

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

open fun post(resp: List<Schedule>)

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

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

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

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

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

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

open override fun route(builder: RouteInfoBuilder)

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

Properties

open override val body: Any?

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

open override val method: HttpMethod

此api请求方式

resultDeserializer

open override val resultDeserializer: DeserializationStrategy<List<Schedule>>

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