simbot-component-qq-guild-api/love.forte.simbot.qguild.api.channel/ModifyChannelApi

ModifyChannelApi

@PrivateDomainOnly

class ModifyChannelApi : PatchQQGuildApi<SimpleChannel> (source)

修改子频道

用于修改 channel_id 指定的子频道的信息。

要求操作人具有 管理子频道 的权限，如果是机器人，则需要将机器人设置为管理员。
修改成功后，会触发子频道更新事件。

Author

ForteScarlet

Types

Body

@Serializable

data class Body(val name: String? = null, val position: Int? = null, val parentId: String? = null, val privateType: PrivateType? = null, val speakPermission: SpeakPermission? = null)

用于 ModifyChannelApi 的请求体。

Factory

object Factory : SimplePatchApiDescription

Properties

body

open override val body: ModifyChannelApi.Body

path

protected open override val path: Array<String>

resultDeserializationStrategy

open override val resultDeserializationStrategy: DeserializationStrategy<SimpleChannel>

Inherited properties

headers

open val headers: Headers

method

open override val method: HttpMethod

此api请求方式

url

open override val url: Url

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

Functions

createBody

protected open override fun createBody(): Any?

Inherited functions

buildUrl

protected open fun URLBuilder.buildUrl()

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

request

@JvmOverloads

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

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

requestAsync

@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

requestBlocking

@QGApi4J

@JvmOverloads

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

QQGuildApi.request for Java

requestData

@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发起一次请求，并得到预期中的结果。

requestDataAsync

@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

requestDataBlocking

@QGApi4J

@JvmOverloads

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

QQGuildApi.requestData for Java

requestDataReserve

@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

requestReserve

@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

requestText

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

@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

requestTextBlocking

@QGApi4J

@JvmOverloads

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

QQGuildApi.requestText for Java

requestTextReserve

@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