simbot-component-kook-api/love.forte.simbot.kook.api.guild.role/GuildRoleListRequest

GuildRoleListRequest

class GuildRoleListRequest(val guildId: ID, pageRequest: PageRequestParameters? = null) : KookGetRequest<KookApiResult.ListData<Role>>

获取服务器角色列表

method: GET

/api/v3/guild-role/list

Parameters

guildId

服务器的id

Constructors

GuildRoleListRequest

fun GuildRoleListRequest(guildId: ID)

GuildRoleListRequest

fun GuildRoleListRequest(guildId: ID, pageRequest: PageRequestParameters? = null)

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<Role>

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

requestDataBlocking

@Api4J

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

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

Properties

val guildId: ID

open override val method: HttpMethod

此请求的 method.

resultDeserializer

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

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

open override val url: Url

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