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

Package-level declarations

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

Types

annotation class Api4J

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

annotation class Api4JS

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

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ApiModel

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

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

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

annotation class InternalApi

一个内部使用的API。

PrivateDomainOnly

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class PrivateDomainOnly

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

object QQGuild

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

QQGuildApiException

open class QQGuildApiException : RuntimeException

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

Functions

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

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

fun ErrInfo.err(code: HttpStatusCode): Nothing

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

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，否则抛出此异常

Properties

val QQGuildApiException.isNotFound: Boolean

判断 QQGuildApiException.value 的值是否为 404

val QQGuildApiException.isUnauthorized: Boolean

判断 QQGuildApiException.value 的值是否为 401