simbot-component-qq-guild-api/love.forte.simbot.qguild.api.member/GetGuildRoleMemberListApi

GetGuildRoleMemberListApi

@PrivateDomainOnly

class GetGuildRoleMemberListApi : GetQQGuildApi<GuildRoleMemberList> (source)

获取频道身份组成员列表

用于获取 guild_id 频道中指定 role_id 身份组下所有成员的详情列表，支持分页。

有关返回结果的说明

每次返回的member数量与limit不一定完全相等。特定管理身份组下的成员可能存在一次性返回全部的情况

Author

ForteScarlet

Types

object Factory : SimpleGetApiDescription

Properties

protected open override val path: Array<String>

resultDeserializationStrategy

open override val resultDeserializationStrategy: DeserializationStrategy<GuildRoleMemberList>

Inherited properties

open override val body: Any?

open val headers: Headers

open override val method: HttpMethod

open override val url: Url

最终用于请求的目标地址。默认会使用 QQGuild.URL 作为其域名地址。

Functions

protected open override fun URLBuilder.buildUrl()

已经完成 path 拼接后、追加其他额外内容（例如parameter）时使用

Inherited functions

suspend fun <R : Any> QQGuildApi<R>.request(client: HttpClient, token: String? = null, server: Url? = null, appId: String? = null): HttpResponse

使用 client 向当前目标 API QQGuildApi 发起请求。

fun QQGuildApi<*>.requestAsync(client: HttpClient, token: String, server: Url = QQGuild.URL, scope: CoroutineScope? = null, appId: String? = null): CompletableFuture<HttpResponse>

QQGuildApi.request for Java

requestBlocking

fun QQGuildApi<*>.requestBlocking(client: HttpClient, token: String?, server: Url = QQGuild.URL, appId: String? = null): HttpResponse

QQGuildApi.request for Java

suspend fun <R : Any> QQGuildApi<R>.requestData(client: HttpClient, token: String?, server: Url? = QQGuild.URL, decoder: Json = QQGuild.DefaultJson, appId: String? = null): R

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

requestDataAsync

fun <R : Any> QQGuildApi<R>.requestDataAsync(client: HttpClient, token: String, server: Url = QQGuild.URL, scope: CoroutineScope? = null, appId: String? = null): CompletableFuture<R>

QQGuildApi.requestData for Java

requestDataBlocking

fun <R : Any> QQGuildApi<R>.requestDataBlocking(client: HttpClient, token: String?, server: Url = QQGuild.URL, appId: String? = null): R

QQGuildApi.requestData for Java

requestDataReserve

fun <R : Any> QQGuildApi<R>.requestDataReserve(client: HttpClient, token: String, server: Url = QQGuild.URL, scope: CoroutineScope? = null, appId: String? = null): SuspendReserve<R>

QQGuildApi.requestData for Java

fun QQGuildApi<*>.requestReserve(client: HttpClient, token: String, server: Url = QQGuild.URL, scope: CoroutineScope? = null, appId: String? = null): SuspendReserve<HttpResponse>

QQGuildApi.request for Java

inline suspend fun <R : Any> QQGuildApi<R>.requestText(client: HttpClient, token: String?, server: Url? = QQGuild.URL, appId: String? = null, useResp: (HttpResponse) -> Unit = {}): String

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

requestTextAsync

fun QQGuildApi<*>.requestTextAsync(client: HttpClient, token: String, server: Url = QQGuild.URL, scope: CoroutineScope? = null, appId: String? = null): CompletableFuture<String>

QQGuildApi.requestText for Java

requestTextBlocking

fun QQGuildApi<*>.requestTextBlocking(client: HttpClient, token: String?, server: Url = QQGuild.URL, appId: String? = null): String

QQGuildApi.requestText for Java

requestTextReserve

fun QQGuildApi<*>.requestTextReserve(client: HttpClient, token: String, server: Url = QQGuild.URL, scope: CoroutineScope? = null, appId: String? = null): SuspendReserve<String>

QQGuildApi.requestText for Java