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

Package-level declarations

api 模块下的部分顶层内容，例如部分标记性注解、模块定义的异常类型、模块使用的常量类等。

Types

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ApiModel

标记一个类型为作为QQ频道中定义的对象模型。

@RequiresOptIn(message = "被标记了 `@ApiModel` 的数据载体类型的构造函数（以及解构函数、copy 函数），为了确保兼容性 **不应** 被直接调用。在后续版本和 5.0 版本之后，它们会被过渡为隐藏了构造的数据类或普通类型。")

@Target(allowedTargets = [AnnotationTarget.CONSTRUCTOR])

annotation class ApiModelConstructor

被标记了 ApiModel 的数据载体类型的构造函数（以及数据类生成的解构函数、copy 函数），为了确保兼容性不应被直接调用。在后续版本和 5.0 版本之后，它们会被过渡为隐藏了构造的数据类或普通类型。

ErrInfo

@Serializable

data class ErrInfo(val code: Int, val message: String, val data: JsonElement = JsonNull)

如果返回值不是成功的响应码，ErrInfo 则为统一的错误码响应格式。

ExperimentalQGMediaApi

@RequiresOptIn(message = "一个实验性的与媒体资源相关的API，可能在未来发生变更或被移除。", level = RequiresOptIn.Level.WARNING)

annotation class ExperimentalQGMediaApi

一个实验性的与媒体资源相关的API，可能在未来发生变更或被移除。

Generated

annotation class Generated

A auto-generated API.

PrivateDomainOnly

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class PrivateDomainOnly

标记一个API类型，代表它是一个在QQ频道API文档中被标记 仅支持私域机器人 的API。

QGApi4J

@RequiresOptIn(message = "API marked for Java use, not recommended for Kotlin.", level = RequiresOptIn.Level.WARNING)

annotation class QGApi4J

一个仅服务于Java的API。对于Kotlin来讲通常有更优选择。

QGApi4JS

@RequiresOptIn(message = "API marked for JS use, not recommended for Kotlin.", level = RequiresOptIn.Level.WARNING)

annotation class QGApi4JS

一个仅服务于JS的API。对于Kotlin来讲通常有更优选择。

QGInternalApi

@RequiresOptIn(message = "Internal API", level = RequiresOptIn.Level.WARNING)

annotation class QGInternalApi

一个内部使用的API。

QQGuild

object QQGuild

QQ頻道API 的一些可能会用到的常量信息，例如正式和沙箱环境的服务器地址。

QQGuildApiException

open class QQGuildApiException : RuntimeException

QQ频道API请求过程中出现的异常

QQGuildResultSerializationException

open class QQGuildResultSerializationException(value: Int, description: String, message: String = ": ") : QQGuildApiException

当 API 相应结果反序列化失败

Inherited properties

isNotFound

val QQGuildApiException.isNotFound: Boolean

判断 QQGuildApiException.value 的值是否为 404

isUnauthorized

val QQGuildApiException.isUnauthorized: Boolean

判断 QQGuildApiException.value 的值是否为 401

Inherited functions

err

fun CloseReason?.err(e: Throwable? = null): Nothing

提供一个 CloseReason，构建为一个 QQGuildApiException 并抛出。

fun ErrInfo.err(code: HttpStatusCode): Nothing

提供 ErrInfo 和 HttpStatusCode ，构建一个 QQGuildApiException 并抛出。

ifNotFoundThen

inline fun <T> QQGuildApiException.ifNotFoundThen(throwCopy: Boolean = true, value: () -> T): T

如果 QQGuildApiException.isNotFound 为 true, 得到null，否则抛出此异常

ifNotFoundThenNoSuch

inline fun QQGuildApiException.ifNotFoundThenNoSuch(throwCopy: Boolean = true, value: () -> String): Nothing

如果 QQGuildApiException.isNotFound 为 true, 得到null，否则抛出此异常

ifNotFoundThenNull

inline fun <T> QQGuildApiException.ifNotFoundThenNull(throwCopy: Boolean = true): T?

如果 QQGuildApiException.isNotFound 为 true, 得到null，否则抛出此异常

initCause0

@QGInternalApi

expect inline fun <T : Throwable> T.initCause0(cause: Throwable): T

初始化 cause, 并得到自身（或结果）在 JVM 平台上生效。在其他平台会使用 addSuppressed 添加 cause。