simbot-component-kook-api/love.forte.simbot.kook.api.channel/ChannelKickoutApi

ChannelKickoutApi

class ChannelKickoutApi : KookPostApi<Unit> (source)

踢出语音频道中的用户

踢出语音频道中的用户，只能踢出在语音频道中的用户

Author

ForteScarlet

Since

4.2.0

Types

Factory

object Factory

Properties

apiPath

protected open override val apiPath: BaseKookApi.ApiPath

API路径片段，例如：

body

open override val body: Any

用于请求的body实体。

resultDeserializationStrategy

open override val resultDeserializationStrategy: DeserializationStrategy<Unit>

预期结果类型的反序列化策略。

Inherited properties

headers

open override val headers: Headers

本次请求提供的请求头。

method

open override val method: HttpMethod

此请求使用的 HttpMethod。

url

open override val url: Url

根据当前API获取请求URL。

Inherited functions

createBody

protected open fun createBody(): Any?

用于为 body 提供实例构造的函数。当得到null时 body 的结果即为null。

initUrl

protected open fun initUrl(): Url

Url 构建器，用于首次初始化 url 时执行，过程中会使用 urlBuild。

request

suspend fun KookApi<*>.request(client: HttpClient, authorization: String): HttpResponse

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult。

requestAsync

@Api4J

@JvmOverloads

fun KookApi<*>.requestAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<HttpResponse>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult。

requestBlocking

@Api4J

fun KookApi<*>.requestBlocking(client: HttpClient, authorization: String): HttpResponse

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult。

requestData

suspend fun <T : Any> KookApi<T>.requestData(client: HttpClient, authorization: String): T

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个具体结果。

requestDataAsync

@Api4J

@JvmOverloads

fun <T : Any> KookApi<T>.requestDataAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<T>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个具体结果。

requestDataBlocking

@Api4J

fun <T : Any> KookApi<T>.requestDataBlocking(client: HttpClient, authorization: String): T

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个具体结果。

requestDataReserve

@Api4J

@JvmOverloads

fun <T : Any> KookApi<T>.requestDataReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<T>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个具体结果。

requestReserve

@Api4J

@JvmOverloads

fun KookApi<*>.requestReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<HttpResponse>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult。

requestResult

suspend fun KookApi<*>.requestResult(client: HttpClient, authorization: String): ApiResult

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult 结果。

requestResultAsync

@Api4J

@JvmOverloads

fun KookApi<*>.requestResultAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<ApiResult>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult 结果。

requestResultBlocking

@Api4J

fun KookApi<*>.requestResultBlocking(client: HttpClient, authorization: String): ApiResult

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult 结果。

requestResultReserve

@Api4J

@JvmOverloads

fun KookApi<*>.requestResultReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<ApiResult>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个 ApiResult 结果。

requestText

suspend fun KookApi<*>.requestText(client: HttpClient, authorization: String): String

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个结果字符串。

requestTextAsync

@Api4J

@JvmOverloads

fun KookApi<*>.requestTextAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<String>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个结果字符串。

requestTextBlocking

@Api4J

fun KookApi<*>.requestTextBlocking(client: HttpClient, authorization: String): String

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个结果字符串。

requestTextReserve

@Api4J

@JvmOverloads

fun KookApi<*>.requestTextReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<String>

通过一个 HttpClient 和校验信息 authorization 对当前API发起请求，并得到一个结果字符串。

urlBuild

protected open fun urlBuild(builder: URLBuilder)

Url 构建器，用于首次初始化 url 时执行的逻辑处理，默认无逻辑，实现类型在有需要的时候重写此方法。