simbot-component-qq-guild-api/love.forte.simbot.qguild.api.role/AddMemberRoleApi

AddMemberRoleApi

class AddMemberRoleApi : PutQQGuildApi<Unit> , QQGuildApiWithoutResult(source)

增加频道身份组成员

用于将频道 guild_id 下的用户 user_id 添加到身份组 role_id 。

需要使用的 token 对应的用户具备增加身份组成员权限。如果是机器人，要求被添加为管理员。
如果要增加的身份组 ID 是 5-子频道管理员，需要增加 channel 对象来指定具体是哪个子频道。

Author

ForteScarlet

Types

object Factory : SimplePutApiDescription

Properties

protected open override val path: Array<String>

Inherited properties

abstract override val body: Any?

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

open val headers: Headers

abstract override val method: HttpMethod

此api请求方式

resultDeserializationStrategy

open override val resultDeserializationStrategy: DeserializationStrategy<Unit>

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

abstract override val url: Url

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

Functions

protected open override fun createBody(): Any?

Inherited functions

protected open fun URLBuilder.buildUrl()

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

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