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

CreateChannelApi

@PrivateDomainOnly

class CreateChannelApi : PostQQGuildApi<SimpleChannel> (source)

创建子频道

用于在 guild_id 指定的频道下创建一个子频道。

要求操作人具有管理频道的权限，如果是机器人，则需要将机器人设置为管理员。
创建成功后，返回创建成功的子频道对象，同时会触发一个频道创建的事件通知。

Author

ForteScarlet

Types

data class Body(val name: String, val type: ChannelType, val subType: ChannelSubType, val position: Int, val parentId: String, val privateType: PrivateType, val privateUserIds: List<String>, val speakPermission: SpeakPermission, val applicationId: String? = null)

CreateChannelApi 的请求体。

object Factory : SimplePostApiDescription

Functions

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

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

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

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

open fun post(resp: SimpleChannel)

当通过 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: CreateChannelApi.Body

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

open override val method: HttpMethod

此api请求方式

resultDeserializer

open override val resultDeserializer: DeserializationStrategy<SimpleChannel>

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