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

Package-level declarations

用于存放QQ频道中各API的响应数据模型。

数据模型与文档中定义的类型基本对应，以不可变数据类 (immutable data class) 的形式定义实现，并通过API模块下的各API响应结果对外提供。

Types

data class Announces @ApiModelConstructor constructor(val guildId: String, val channelId: String, val messageId: String, val announcesType: UInt, val recommendChannels: List<RecommendChannel> = emptyList())

data class ApiPermission @ApiModelConstructor constructor(val path: String, val method: String, val desc: String, val authStatus: Int)

data class ApiPermissionDemand @ApiModelConstructor constructor(val guildId: String, val channelId: String, val apiIdentify: ApiPermissionDemandIdentify, val title: String, val desc: String)

接口权限需求对象（APIPermissionDemand）

ApiPermissionDemandIdentify

@Serializable

data class ApiPermissionDemandIdentify(val path: String, val method: String)

接口权限需求标识对象（APIPermissionDemandIdentify）

Channel

interface Channel : Comparable<Channel>

data class ChannelPermissions @ApiModelConstructor constructor(val channelId: String, val userId: String? = null, val roleId: String? = null, val permissions: Permissions)

子频道权限对象(ChannelPermissions)

ChannelSubType

@Serializable(with = ChannelSubTypeSerializer::class)

class ChannelSubType

ChannelSubType

ChannelType

@Serializable(with = ChannelTypeSerializer::class)

class ChannelType

ChannelType

ColorIntSerializer

object ColorIntSerializer : KSerializer<Int>

DirectMessageSession

@Serializable

data class DirectMessageSession(val guildId: String, val channelId: String, val createTime: String)

私信会话对象（DMS）

Emoji

data class Emoji(val id: String, val type: Int)

object EmojiTypes

interface Guild

interface Member

interface MemberWithGuildId : Member

data class Message @ApiModelConstructor constructor(val id: String, val channelId: String, val guildId: String, val content: String, val timestamp: String, val editedTimestamp: String? = null, val mentionEveryone: Boolean = false, val author: User, val attachments: List<Message.Attachment> = emptyList(), val embeds: List<Message.Embed> = emptyList(), val mentions: List<User> = emptyList(), val member: MessageMember? = null, val ark: Message.Ark? = null, val seqInChannel: String, val messageReference: Message.Reference? = null, val srcGuildId: String? = null)

消息对象(Message)

MessageAudited

@Serializable

data class MessageAudited(val auditId: String, val messageId: String? = null, val guildId: String, val channelId: String, val auditTime: String, val createTime: String, val seqInChannel: String)

消息审核对象(MessageAudited)

MessageKeyboard

@ApiModel

@Serializable

data class MessageKeyboard @ApiModelConstructor constructor(val id: String? = null, val renderData: MessageKeyboard.RenderData? = null, val action: MessageKeyboard.Action? = null)

消息交互=>消息按钮

MessageKeyboardActionBuilder

class MessageKeyboardActionBuilder

MessageKeyboard.Action 的构建器。

MessageKeyboardActionPermissionBuilder

class MessageKeyboardActionPermissionBuilder

MessageKeyboard.ActionPermission 的构建器。

MessageKeyboardBuilder

class MessageKeyboardBuilder(var id: String? = null)

用于更便捷构建 MessageKeyboard 的构建器，Java 中可用链式 API，Kotlin 额外提供一些 DSL API。

MessageKeyboardButton

typealias MessageKeyboardButton = MessageKeyboard

MessageKeyboardRenderDataBuilder

class MessageKeyboardRenderDataBuilder

用于构建一个 MessageKeyboard.RenderData 对象。

MessageKeyboards

@Serializable

data class MessageKeyboards

消息交互=>消息按钮

MessageKeyboardsBuilder

class MessageKeyboardsBuilder

用于更便捷构建 MessageKeyboards 的构建器，Java 中可用链式 API，Kotlin 额外提供一些 DSL API。

MessageKeyboardsContentBuilder

class MessageKeyboardsContentBuilder

用于构建 MessageKeyboards.Content 的构建器。

MessageKeyboardsContentRowBuilder

class MessageKeyboardsContentRowBuilder

用于构建 MessageKeyboards.ContentRow 的构建器。

MessageMedia

@ApiModel

@Serializable

data class MessageMedia @ApiModelConstructor constructor(val fileUuid: String, val fileInfo: String, val ttl: Int, val id: String? = null)

data class MessageMember @ApiModelConstructor constructor(val nick: String = "", val roles: List<String> = emptyList(), val joinedAt: String = ZERO_ISO_INSTANT) : Member

在 MessageMember 中使用的 Member 实现。其中的 user 来自 Message.author

MessageSetting

@Serializable

data class MessageSetting(val disableCreateDm: String, val disablePushMsg: String, val channelIds: List<String>, val channelPushMaxNum: Int)

频道消息频率设置对象 (MessageSetting)

Permissions

@Serializable(with = PermissionsSerializer::class)

@JvmInline

value class Permissions(val value: Long)

data class PinsMessage @ApiModelConstructor constructor(val guildId: String, val channelId: String, val messageIds: List<String> = emptyList())

精华消息对象

PrivateType

@Serializable(with = PrivateTypeSerializer::class)

enum PrivateType : Enum<PrivateType>

data class RecommendChannel @ApiModelConstructor constructor(val channelId: String, val introduce: String)

推荐子频道对象(RecommendChannel)

Role

@ApiModel

@Serializable

data class Role @ApiModelConstructor constructor(val id: String, val name: String, val color: Int, val hoist: Int, val number: Int, val memberLimit: Int)

data class Schedule @ApiModelConstructor constructor(val id: String, val name: String, val description: String, val startTimestamp: Long, val endTimestamp: Long, val creator: SimpleMember, val jumpChannelId: String, val remindType: String)

data class SendMessageMedia @ApiModelConstructor constructor(val fileInfo: String)

data class SimpleChannel @ApiModelConstructor constructor(val id: String, val guildId: String, val name: String, val type: ChannelType, val subType: ChannelSubType, val position: Int, val parentId: String, val ownerId: String, val privateType: PrivateType? = null, val speakPermission: SpeakPermission? = null, val applicationId: String? = null, val permissions: Permissions? = null) : Channel

Channel 的基础实现。

SimpleGuild

@ApiModel

@Serializable

data class SimpleGuild @ApiModelConstructor constructor(val id: String, val name: String, val icon: String, val ownerId: String, val isOwner: Boolean, val memberCount: Int, val maxMembers: Int, val description: String, val joinedAt: String) : Guild

Guild 的基础实现。

SimpleMember

@ApiModel

@Serializable

data class SimpleMember @ApiModelConstructor constructor(val user: User, val nick: String, val roles: List<String> = emptyList(), val joinedAt: String) : Member

Member 的简单基本实现。

SimpleMemberWithGuildId

@ApiModel

@Serializable

data class SimpleMemberWithGuildId @ApiModelConstructor constructor(val guildId: String, val user: User, val nick: String, val roles: List<String> = emptyList(), val joinedAt: String = ZERO_ISO_INSTANT) : MemberWithGuildId

MemberWithGuildId 的简单基本实现。

SpeakPermission

@Serializable(with = SpeakPermissionSerializer::class)

enum SpeakPermission : Enum<SpeakPermission>

data class User @ApiModelConstructor constructor(val id: String, val username: String, val avatar: String = "", val isBot: Boolean = false, val unionOpenid: String? = null, val unionUserAccount: String? = null)

用户对象

Inherited properties

isAuthorized

val ApiPermission.isAuthorized: Boolean

判断 ApiPermission.authStatus 的值是否为 1

isCategory

val ChannelType.isCategory: Boolean

Functions

buildMessageKeyboard

inline fun buildMessageKeyboard(block: MessageKeyboardBuilder.() -> Unit): MessageKeyboard

通过 DSL 构建 MessageKeyboard。

MessageKeyboards

inline fun MessageKeyboards(block: MessageKeyboardsBuilder.() -> Unit): MessageKeyboards

通过 DSL 构建 MessageKeyboards。

Inherited functions

forSend

fun MessageMedia.forSend(): SendMessageMedia

MessageMedia to SendMessageMedia