simbot-component-kook-api/love.forte.simbot.kook.api/BaseKookApi

BaseKookApi

abstract class BaseKookApi<T : Any> : KookApi<T> (source)

KookApi 的进一步抽象实现，简化针对 KookApi.url 的构造过程。

Inheritors

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
protected sealed class ApiPath

提供API的完整路径后缀信息。

Properties

Link copied to clipboard
protected abstract val apiPath: BaseKookApi.ApiPath

API路径片段，例如：

Link copied to clipboard
open override val headers: Headers

本次请求提供的请求头。

Link copied to clipboard
open override val url: Url

根据当前API获取请求URL。

Inherited properties

Link copied to clipboard
abstract override val body: Any?

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

Link copied to clipboard
abstract override val method: HttpMethod

此请求使用的 HttpMethod。

Link copied to clipboard
abstract override val resultDeserializationStrategy: DeserializationStrategy<T>

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

Functions

Link copied to clipboard
protected open fun initUrl(): Url

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

Link copied to clipboard
protected open fun urlBuild(builder: URLBuilder)

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

Inherited functions

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

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

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<HttpResponse>

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

Link copied to clipboard
@Api4J
fun KookApi<*>.requestBlocking(client: HttpClient, authorization: String): HttpResponse

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

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

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

Link copied to clipboard
@Api4J
@JvmOverloads
fun <T : Any> KookApi<T>.requestDataAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<T>

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

Link copied to clipboard
@Api4J
fun <T : Any> KookApi<T>.requestDataBlocking(client: HttpClient, authorization: String): T

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

Link copied to clipboard
@Api4J
@JvmOverloads
fun <T : Any> KookApi<T>.requestDataReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<T>

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

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<HttpResponse>

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

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

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

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestResultAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<ApiResult>

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

Link copied to clipboard
@Api4J
fun KookApi<*>.requestResultBlocking(client: HttpClient, authorization: String): ApiResult

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

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestResultReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<ApiResult>

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

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

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

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestTextAsync(client: HttpClient, authorization: String, scope: CoroutineScope? = null): CompletableFuture<String>

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

Link copied to clipboard
@Api4J
fun KookApi<*>.requestTextBlocking(client: HttpClient, authorization: String): String

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

Link copied to clipboard
@Api4J
@JvmOverloads
fun KookApi<*>.requestTextReserve(client: HttpClient, authorization: String, scope: CoroutineScope? = null): SuspendReserve<String>

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