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

GetGuildMemberListApi

@PrivateDomainOnly
class GetGuildMemberListApi : GetQQGuildApi<List<SimpleMember>> (source)

获取频道成员列表

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

有关返回结果的说明

  1. 在每次翻页的过程中，可能会返回上一次请求已经返回过的 member 信息，需要调用方自己根据 user id 来进行去重。

  2. 每次返回的 member 数量与 limit 不一定完全相等。翻页请使用最后一个 member 的 user id 作为下一次请求的 after 参数，直到回包为空，拉取结束。

Author

ForteScarlet

Throws

limit 不大于0时

Types

Link copied to clipboard

Properties

Link copied to clipboard
protected open override val path: Array<String>
Link copied to clipboard

Inherited properties

Link copied to clipboard
open override val body: Any?
Link copied to clipboard
open val headers: Headers
Link copied to clipboard
open override val method: HttpMethod
Link copied to clipboard
open override val url: Url

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

Functions

Link copied to clipboard
protected open override fun URLBuilder.buildUrl()

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

Inherited functions

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

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

Link copied to clipboard
@QGApi4J
@JvmOverloads
fun QQGuildApi<*>.requestAsync(client: HttpClient, token: String, server: Url = QQGuild.URL, scope: CoroutineScope? = null, appId: String? = null): CompletableFuture<HttpResponse>

QQGuildApi.request for Java

Link copied to clipboard
@QGApi4J
@JvmOverloads
fun QQGuildApi<*>.requestBlocking(client: HttpClient, token: String?, server: Url = QQGuild.URL, appId: String? = null): HttpResponse

QQGuildApi.request for Java

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

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

Link copied to clipboard
@QGApi4J
@JvmOverloads
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

Link copied to clipboard
@QGApi4J
@JvmOverloads
fun <R : Any> QQGuildApi<R>.requestDataBlocking(client: HttpClient, token: String?, server: Url = QQGuild.URL, appId: String? = null): R

QQGuildApi.requestData for Java

Link copied to clipboard
@QGApi4J
@JvmOverloads
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

Link copied to clipboard
@QGApi4J
@JvmOverloads
fun QQGuildApi<*>.requestReserve(client: HttpClient, token: String, server: Url = QQGuild.URL, scope: CoroutineScope? = null, appId: String? = null): SuspendReserve<HttpResponse>

QQGuildApi.request for Java

Link copied to clipboard
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日志后返回。 不会进行校验。

Link copied to clipboard
@QGApi4J
@JvmOverloads
fun QQGuildApi<*>.requestTextAsync(client: HttpClient, token: String, server: Url = QQGuild.URL, scope: CoroutineScope? = null, appId: String? = null): CompletableFuture<String>

QQGuildApi.requestText for Java

Link copied to clipboard
@QGApi4J
@JvmOverloads
fun QQGuildApi<*>.requestTextBlocking(client: HttpClient, token: String?, server: Url = QQGuild.URL, appId: String? = null): String

QQGuildApi.requestText for Java

Link copied to clipboard
@QGApi4J
@JvmOverloads
fun QQGuildApi<*>.requestTextReserve(client: HttpClient, token: String, server: Url = QQGuild.URL, scope: CoroutineScope? = null, appId: String? = null): SuspendReserve<String>

QQGuildApi.requestText for Java