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

ModifyGuildRoleApi

class ModifyGuildRoleApi : QQGuildApi<GuildRoleModified> (source)

修改频道身份组

用于修改频道 guild_id 下 role_id 指定的身份组。

需要使用的 token 对应的用户具备修改身份组权限。如果是机器人，要求被添加为管理员。
接口会修改传入的字段，不传入的默认不会修改，至少要传入一个参数。

Author

ForteScarlet

Types

object Factory : SimpleApiDescription

Functions

open suspend override fun doRequest(client: HttpClient, server: Url, token: String, decoder: StringFormat): GuildRoleModified

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

open suspend override fun doRequestRaw(client: HttpClient, server: Url, token: String): String

使用此api发起一次请求，并得到响应结果的字符串。

open fun post(resp: GuildRoleModified)

当通过 doRequest 得到成功结果后进行的操作。

suspend fun <R> QQGuildApi<R>.request(client: HttpClient = QQGuildApi.DefaultHttpClient, server: Url, token: String, decoder: StringFormat = QQGuildApi.DefaultJsonDecoder): R

通过提供的参数，对此api进行请求并得到最终结果。

requestForResponse

protected suspend fun requestForResponse(client: HttpClient, server: Url, token: String, json: Json = DefaultJsonDecoder): HttpResponse

protected inline suspend fun requestForText(client: HttpClient, server: Url, token: String, useResp: (HttpResponse) -> Unit = {}): String

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

suspend fun QQGuildApi<*>.requestRaw(client: HttpClient = QQGuildApi.DefaultHttpClient, server: Url, token: String): String

通过提供的参数，对此api进行请求并得到最终结果。

open override fun route(builder: RouteInfoBuilder)

此请求对应的api路由路径以及路径参数。例如：/guild/list

Properties

open override val body: Any

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

open override val method: HttpMethod

此api请求方式

resultDeserializer

open override val resultDeserializer: DeserializationStrategy<GuildRoleModified>

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