simbot-component-kook-api/love.forte.simbot.kook.api.invite/InviteListRequest

InviteListRequest

class InviteListRequest(guildId: ID?, channelId: ID?, page: Int = -1, pageSize: Int = -1) : KookGetRequest<KookApiResult.ListData<InviteInfo>>

获取邀请列表

/api/v3/invite/list

method: GET

Parameters

guildId

服务器 id. 服务器 id 或者频道 id 必须填一个

channelId

频道 id. 服务器 id 或者频道 id 必须填一个

page

目标页数. 不小于0时有效。

pageSize

每页数据数量. 不小于0时有效。

Constructors

InviteListRequest

fun InviteListRequest(guildId: ID?, channelId: ID?, page: Int = -1, pageSize: Int = -1)

Types

object Key : BaseKookApiRequestKey

Functions

open suspend fun request(client: HttpClient, authorization: String, decoder: Json = DEFAULT_JSON, postChecker: suspend (HttpResponse) -> Unit = {}): ApiResult

通过 client 执行网络请求并尝试得到结果。

requestBlocking

@Api4J

open fun requestBlocking(client: HttpClient, authorization: String, decoder: Json = DEFAULT_JSON, postChecker: Consumer<HttpResponse> = defaultRequestPostChecker): ApiResult

通过 client 执行网络请求并尝试得到结果。

open suspend fun requestData(client: HttpClient, authorization: String, decoder: Json = DEFAULT_JSON): KookApiResult.ListData<InviteInfo>

通过 client 执行网络请求并尝试得到结果。

requestDataBlocking

@Api4J

open fun requestDataBlocking(client: HttpClient, authorization: String, decoder: Json = DEFAULT_JSON): KookApiResult.ListData<InviteInfo>

通过 client 执行网络请求并尝试得到结果。

Properties

open override val method: HttpMethod

此请求的 method.

resultDeserializer

open override val resultDeserializer: DeserializationStrategy<out KookApiResult.ListData<InviteInfo>>

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

open override val url: Url

通过 apiPaths 和 buildParameters 懒构建 url 属性。