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

Package-level declarations

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

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

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

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

Types

interface ApiDescription

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

data class Gateway(val url: String) : GatewayInfo

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

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

获取网关信息。

sealed class GatewayInfo

Base sealed class for Gateway and GatewayWithShard.

GatewayWithShard

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

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

abstract class GetQQGuildApi<R> : QQGuildApi<R>

MessageAuditedException

class MessageAuditedException : QQGuildApiException

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

MessageAuditedId

data class MessageAuditedId(val auditId: String)

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

NumberAsBooleanSerializer

object NumberAsBooleanSerializer : KSerializer<Boolean>

PlatformQQGuildApi

expect abstract class PlatformQQGuildApi<out R>

用于多平台实现的最小目标。

actual abstract class PlatformQQGuildApi<out R>

用于多平台实现的最小目标。

actual abstract class PlatformQQGuildApi<out R>

用于多平台实现的最小目标。

actual abstract class PlatformQQGuildApi<out R>

用于多平台实现的最小目标。

abstract class PostQQGuildApi<R> : QQGuildApi<R>

abstract class QQGuildApi<out R> : PlatformQQGuildApi<R>

表示为一个QQ频道的API。

QQGuildApiWithoutResult

abstract class 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 的基本抽象实现类，直接通过构造进行继承。

SimpleGetApiDescription

abstract class SimpleGetApiDescription(val path: String) : SimpleApiDescription

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

SimplePostApiDescription

abstract class SimplePostApiDescription(val path: String) : SimpleApiDescription

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

Functions

fun <R> doRequest(api: QQGuildApi<R>, client: HttpClient, server: String, token: String, decoder: StringFormat = QQGuildApi.DefaultJsonDecoder): R

request for Java

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

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

fun newHttpClient(): HttpClient

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

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

用于在Java中构建一个 Json。

suspend fun <R> QQGuildApi<R>.request(client: HttpClient = QQGuildApi.DefaultHttpClient, server: Url, token: String, decoder: StringFormat = QQGuildApi.DefaultJsonDecoder): R

通过提供的参数，对此api进行请求并得到最终结果。

suspend fun QQGuildApi<*>.requestRaw(client: HttpClient = QQGuildApi.DefaultHttpClient, server: Url, token: String): String

通过提供的参数，对此api进行请求并得到最终结果。