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

Package-level declarations

与QQ频道开发者文档中定义的API进行对照实现的模块。

与QQ频道开发者文档中定义的API进行对照实现的模块。

Types

interface ApiDescription

对一个 API 类型的描述，属性格式与接口权限对象中的相关信息保持一致。

DeleteQQGuildApi

abstract class DeleteQQGuildApi<R : Any> : DeleteApiDefinition<R> , QQGuildApi<R>

@SerialName(value = "n")

data class Gateway(val url: String) : GatewayInfo

一个用于连接 websocket 的地址。GatewayApis.Normal 的响应体。

sealed class GatewayApis<R : GatewayInfo>(val path: Array<String>, val resultDeserializationStrategy: DeserializationStrategy<R>) : GetQQGuildApi<R>

获取网关信息。

sealed class GatewayInfo

Base sealed class for Gateway and GatewayWithShard.

GatewayWithShard

@SerialName(value = "s")

data class GatewayWithShard(val url: String, val shards: Int, val sessionStartLimit: SessionStartLimit) : GatewayInfo

一个用于连接 websocket 的地址。同时返回建议的分片数，以及目前连接数使用情况。 GatewayApis.Shared 的响应体。

abstract class GetQQGuildApi<R : Any> : GetApiDefinition<R> , QQGuildApi<R>

MessageAuditedException

class MessageAuditedException : QQGuildApiException

消息被审核' 异常。当推送、回复消息时响应的 code 错误码为 304023、304024 时会在响应数据包 data 中返回 MessageAudit 审核消息的信息，例如：

MessageAuditedId

data class MessageAuditedId(val auditId: String)

推送、回复消息时响应的 '消息被审核' 数据信息。

NumberAsBooleanSerializer

object NumberAsBooleanSerializer : KSerializer<Boolean>

PatchQQGuildApi

abstract class PatchQQGuildApi<R : Any> : PutQQGuildApi<R> , QQGuildApi<R>

abstract class PostQQGuildApi<R : Any> : PostApiDefinition<R> , QQGuildApi<R>

abstract class PutQQGuildApi<R : Any> : PutApiDefinition<R> , QQGuildApi<R>

interface QQGuildApi<out R : Any> : ApiDefinition<R>

表示为一个QQ频道的API。

QQGuildApiWithoutResult

interface QQGuildApiWithoutResult : QQGuildApi<Unit>

SessionStartLimit

data class SessionStartLimit(val total: Int, val remaining: Int, val resetAfter: Int, val maxConcurrency: Int)

SimpleApiDescription

abstract class SimpleApiDescription(method: HttpMethod, val path: String) : ApiDescription

ApiDescription 的基本抽象实现类，直接通过构造进行继承。

SimpleDeleteApiDescription

abstract class SimpleDeleteApiDescription(val path: String) : SimpleApiDescription

SimpleApiDescription 的基本抽象实现，method 提供为 HttpMethod.Delete

SimpleGetApiDescription

abstract class SimpleGetApiDescription(val path: String) : SimpleApiDescription

SimpleApiDescription 的基本抽象实现，method 提供为 GET

SimplePatchApiDescription

abstract class SimplePatchApiDescription(val path: String) : SimpleApiDescription

SimpleApiDescription 的基本抽象实现，method 提供为 HttpMethod.Patch

SimplePostApiDescription

abstract class SimplePostApiDescription(val path: String) : SimpleApiDescription

SimpleApiDescription 的基本抽象实现，method 提供为 POST

SimplePutApiDescription

abstract class SimplePutApiDescription(val path: String) : SimpleApiDescription

SimpleApiDescription 的基本抽象实现，method 提供为 HttpMethod.Put

Properties

val apiLogger: Logger

用于在 QQGuildApi.request 及其衍生API中输出相关日志的 Logger。开启 love.forte.simbot.qguild.api 的 DEBUG 级别日志可以得到更多在 API 请求过程中产生的信息。注意：这可能会暴露其中的参数、返回值等，请注意保护敏感信息。

X_UNION_APPID_HEADER

const val X_UNION_APPID_HEADER: String

格式值："BOT_APPID", 机器人 AppID

Functions

fun newHttpClient(): HttpClient

用于在Java中构建一个默认的 HttpClient。

fun newJson(build: Consumer<JsonBuilder> = Consumer { it.apply { isLenient = true ignoreUnknownKeys = true } }): Json

用于在Java中构建一个 Json。

Inherited functions

infix fun ApiDescription.eq(other: ApiDescription): Boolean

用于判断两个 ApiDescription 中的两个属性是否相同。

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

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

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

QQGuildApi.request for Java

requestBlocking

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

QQGuildApi.request for Java

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

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

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

QQGuildApi.requestData for Java

requestDataReserve

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

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

QQGuildApi.request for Java

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

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

QQGuildApi.requestText for Java

requestTextBlocking

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

QQGuildApi.requestText for Java

requestTextReserve

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

QQGuildApi.requestText for Java