Simple Robot 组件 | QQ

4.4.0

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

Package-level declarations

QQ频道的事件相关内容，包括事件订阅、 opcode 以及推送的各种事件消息体等。

Types

AtMessageCreate

@SerialName(value = "AT_MESSAGE_CREATE")

data class AtMessageCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Message) : MessageDispatch

消息事件 AT_MESSAGE_CREATE（intents PUBLIC_GUILD_MESSAGES）

C2CManagementData

data class C2CManagementData(val timestamp: String, val openid: String)

C2CManagementDispatch 的事件数据

C2CManagementDispatch

sealed class C2CManagementDispatch : Signal.Dispatch

用户模块-用户管理相关事件。 data 类型为 C2CManagementData

C2CMessageCreate

@SerialName(value = "C2C_MESSAGE_CREATE")

data class C2CMessageCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: C2CMessageCreate.Data) : Signal.Dispatch

@SerialName(value = "C2C_MSG_RECEIVE")

data class C2CMsgReceive(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: C2CManagementData) : C2CManagementDispatch

允许机器人主动消息

@SerialName(value = "C2C_MSG_REJECT")

data class C2CMsgReject(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: C2CManagementData) : C2CManagementDispatch

拒绝机器人主动消息

@SerialName(value = "CHANNEL_CREATE")

data class ChannelCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: EventChannel) : ChannelDispatch

子频道事件 CHANNEL_CREATE

@SerialName(value = "CHANNEL_DELETE")

data class ChannelDelete(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: EventChannel) : ChannelDispatch

子频道事件 CHANNEL_DELETE

ChannelDispatch

sealed class ChannelDispatch : Signal.Dispatch

channel相关的事件类型。data 类型为 EventChannel。

@SerialName(value = "CHANNEL_UPDATE")

data class ChannelUpdate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: EventChannel) : ChannelDispatch

子频道事件 CHANNEL_UPDATE

DirectMessageCreate

@SerialName(value = "DIRECT_MESSAGE_CREATE")

data class DirectMessageCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Message) : MessageDispatch

私信消息事件 DIRECT_MESSAGE_CREATE (intents DIRECT_MESSAGE)

data class EventChannel @ApiModelConstructor constructor(val id: String, val guildId: String, val name: String, val type: ChannelType, val subType: ChannelSubType, val ownerId: String, val opUserId: String)

子频道事件中接收到的 Channel 信息。

data class EventGuild @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, val opUserId: String) : Guild

EventGuildDispatch

sealed class EventGuildDispatch : Signal.Dispatch

Guild相关事件类型。data 类型为 EventGuild。

sealed class EventIntents

各事件的 intents 和类型常量。

EventIntentsAggregation

object EventIntentsAggregation

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

频道成员事件体。

@PrivateDomainOnly

sealed class ForumDispatch : Signal.Dispatch

论坛事件(ForumEvent)

ForumPostCreate

@SerialName(value = "FORUM_POST_CREATE")

data class ForumPostCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Post) : ForumPostDispatch

帖子创建事件

ForumPostDelete

@SerialName(value = "FORUM_POST_DELETE")

data class ForumPostDelete(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Post) : ForumPostDispatch

帖子删除事件

ForumPostDispatch

sealed class ForumPostDispatch : ForumDispatch

论坛事件：帖子事件

ForumPublishAuditResult

@SerialName(value = "FORUM_PUBLISH_AUDIT_RESULT")

data class ForumPublishAuditResult(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: AuditResult) : ForumDispatch

帖子审核事件

ForumReplyCreate

@SerialName(value = "FORUM_REPLY_CREATE")

data class ForumReplyCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Reply) : ForumReplyDispatch

回复创建事件

ForumReplyDelete

@SerialName(value = "FORUM_REPLY_DELETE")

data class ForumReplyDelete(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Reply) : ForumReplyDispatch

回复删除事件

ForumReplyDispatch

sealed class ForumReplyDispatch : ForumDispatch

论坛事件：回复事件

ForumThreadCreate

@SerialName(value = "FORUM_THREAD_CREATE")

data class ForumThreadCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Thread) : ForumThreadDispatch

主题创建事件。

ForumThreadDelete

@SerialName(value = "FORUM_THREAD_DELETE")

data class ForumThreadDelete(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Thread) : ForumThreadDispatch

主题删除事件。

ForumThreadDispatch

sealed class ForumThreadDispatch : ForumDispatch

论坛事件：主题事件

ForumThreadUpdate

@SerialName(value = "FORUM_THREAD_UPDATE")

data class ForumThreadUpdate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Thread) : ForumThreadDispatch

主题更新事件。

@SerialName(value = "FRIEND_ADD")

data class FriendAdd(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: C2CManagementData) : C2CManagementDispatch

用户添加机器人

@SerialName(value = "FRIEND_DEL")

data class FriendDel(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: C2CManagementData) : C2CManagementDispatch

用户删除机器人

@SerialName(value = "GROUP_ADD_ROBOT")

data class GroupAddRobot(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: GroupRobotManagementData) : GroupRobotManagementDispatch

机器人加入群聊

GroupAtMessageCreate

@SerialName(value = "GROUP_AT_MESSAGE_CREATE")

data class GroupAtMessageCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: GroupAtMessageCreate.Data) : Signal.Dispatch

群聊@机器人

@SerialName(value = "GROUP_DEL_ROBOT")

data class GroupDelRobot(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: GroupRobotManagementData) : GroupRobotManagementDispatch

机器人退出群聊

@SerialName(value = "GROUP_MEMBER_ADD")

data class GroupMemberAdd : GroupMemberManagementDispatch

群成员加入群聊

GroupMemberManagementData

data class GroupMemberManagementData

GroupMemberManagementDispatch 事件的数据体。

GroupMemberManagementDispatch

sealed class GroupMemberManagementDispatch : Signal.Dispatch

群成员进退群聊事件。 data 类型为 GroupMemberManagementData

GroupMemberRemove

@SerialName(value = "GROUP_MEMBER_REMOVE")

data class GroupMemberRemove : GroupMemberManagementDispatch

群成员退出群聊

GroupMessageAuthor

sealed interface GroupMessageAuthor

群聊消息体内的发信人信息。

GroupMessageAuthorRole

enum GroupMessageAuthorRole : Enum<GroupMessageAuthorRole>

群聊消息体内的发信人身份。

GroupMessageCreate

@SerialName(value = "GROUP_MESSAGE_CREATE")

data class GroupMessageCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: GroupMessageCreate.Data) : Signal.Dispatch

群聊全量消息

GroupMessageData

sealed interface GroupMessageData

群聊消息内容体

GroupMsgReceive

@SerialName(value = "GROUP_MSG_RECEIVE")

data class GroupMsgReceive(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: GroupRobotManagementData) : GroupRobotManagementDispatch

群聊接受机器人主动消息

@SerialName(value = "GROUP_MSG_REJECT")

data class GroupMsgReject(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: GroupRobotManagementData) : GroupRobotManagementDispatch

群聊拒绝机器人主动消息

GroupRobotManagementData

data class GroupRobotManagementData(val timestamp: String, val groupOpenid: String, val opMemberOpenid: String)

GroupRobotManagementDispatch

sealed class GroupRobotManagementDispatch : Signal.Dispatch

群聊模块-群管理相关事件。 data 类型为 GroupRobotManagementData

@SerialName(value = "GUILD_CREATE")

data class GuildCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: EventGuild) : EventGuildDispatch

@SerialName(value = "GUILD_DELETE")

data class GuildDelete(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: EventGuild) : EventGuildDispatch

@SerialName(value = "GUILD_MEMBER_ADD")

data class GuildMemberAdd(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: EventMember) : Signal.Dispatch

GUILD_MEMBER_ADD

GuildMemberRemove

@SerialName(value = "GUILD_MEMBER_REMOVE")

data class GuildMemberRemove(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: EventMember) : Signal.Dispatch

GUILD_MEMBER_REMOVE

GuildMemberUpdate

@SerialName(value = "GUILD_MEMBER_UPDATE")

data class GuildMemberUpdate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: EventMember) : Signal.Dispatch

GUILD_MEMBER_UPDATE

@SerialName(value = "GUILD_UPDATE")

data class GuildUpdate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: EventGuild) : EventGuildDispatch

value class Intents(val value: Int)

IntentsAppender

interface IntentsAppender

一个 Intents 追加器。用于方便配置类等类型对外提供Kotlin中更便捷的DSL API使用的接口类型。

IntentsAppenderOp

value class IntentsAppenderOp(appender: IntentsAppender)

InteractionCreate

@SerialName(value = "INTERACTION_CREATE")

data class InteractionCreate : Signal.Dispatch

互动事件创建时。

InteractionCreateData

data class InteractionCreateData

互动事件的数据。

InteractionCreateEventData

data class InteractionCreateEventData

互动事件的事件体。

InteractionCreateResolvedData

data class InteractionCreateResolvedData

互动事件解析后的数据。

MessageAuditedDispatch

sealed class MessageAuditedDispatch : Signal.Dispatch

与 MessageAudited 相关的事件类型。data 类型为 MessageAudited。

MessageAuditPass

@SerialName(value = "MESSAGE_AUDIT_PASS")

data class MessageAuditPass(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: MessageAudited) : MessageAuditedDispatch

消息审核事件 MESSAGE_AUDIT_PASS（intents MESSAGE_AUDIT）

MessageAuditReject

@SerialName(value = "MESSAGE_AUDIT_REJECT")

data class MessageAuditReject(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: MessageAudited) : MessageAuditedDispatch

消息审核事件 MESSAGE_AUDIT_REJECT（intents MESSAGE_AUDIT）

@SerialName(value = "MESSAGE_CREATE")

data class MessageCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Message) : MessageDispatch

发送消息事件，代表频道内的全部消息，而不只是 at 机器人的消息。内容与 AT_MESSAGE_CREATE 相同

@SerialName(value = "MESSAGE_DELETE")

data class MessageDelete(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Unit) : Signal.Dispatch

删除（撤回）消息事件

MessageDispatch

sealed class MessageDispatch : Signal.Dispatch

与 message 相关的事件类型。data 类型为 Message

@Serializable(with = Opcode.SerializerByCode::class)

sealed class Opcode(val code: Int)

针对 Opcodes 中各 opcode 的实例类型。

object Opcodes

opcode 常量类。

OpenForumDispatch

sealed class OpenForumDispatch : Signal.Dispatch

开放论坛事件(OpenForumEvent) 相关的事件父类。

OpenForumEventData

sealed class OpenForumEventData : ForumSourceInfo

开放论坛事件中三种类型事件内信息的统一抽象。

OpenForumPostCreate

@SerialName(value = "OPEN_FORUM_POST_CREATE")

data class OpenForumPostCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: OpenForumPostData) : OpenForumPostDispatch

帖子事件：创建帖子（评论）

OpenForumPostData

data class OpenForumPostData @ApiModelConstructor constructor(val guildId: String, val channelId: String, val authorId: String) : OpenForumEventData

开放论坛事件中 帖子（评论）事件 的内容。

OpenForumPostDelete

@SerialName(value = "OPEN_FORUM_POST_DELETE")

data class OpenForumPostDelete(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: OpenForumPostData) : OpenForumPostDispatch

帖子事件：删除帖子（评论）

OpenForumPostDispatch

sealed class OpenForumPostDispatch : OpenForumDispatch

开放论坛事件的 帖子（评论）事件。

OpenForumReplyCreate

@SerialName(value = "OPEN_FORUM_REPLY_CREATE")

data class OpenForumReplyCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: OpenForumReplyData) : OpenForumReplyDispatch

回复事件：创建回复

OpenForumReplyData

data class OpenForumReplyData @ApiModelConstructor constructor(val guildId: String, val channelId: String, val authorId: String) : OpenForumEventData

开放论坛事件中 回复事件 的内容。

OpenForumReplyDelete

@SerialName(value = "OPEN_FORUM_REPLY_DELETE")

data class OpenForumReplyDelete(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: OpenForumReplyData) : OpenForumReplyDispatch

回复事件：删除回复

OpenForumReplyDispatch

sealed class OpenForumReplyDispatch : OpenForumDispatch

开放论坛事件的 回复事件。

OpenForumThreadCreate

@SerialName(value = "OPEN_FORUM_THREAD_CREATE")

data class OpenForumThreadCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: OpenForumThreadData) : OpenForumThreadDispatch

主题事件：创建主题

OpenForumThreadData

data class OpenForumThreadData @ApiModelConstructor constructor(val guildId: String, val channelId: String, val authorId: String) : OpenForumEventData

开放论坛事件中 主题事件 的内容。

OpenForumThreadDelete

@SerialName(value = "OPEN_FORUM_THREAD_DELETE")

data class OpenForumThreadDelete(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: OpenForumThreadData) : OpenForumThreadDispatch

主题事件：删除主题

OpenForumThreadDispatch

sealed class OpenForumThreadDispatch : OpenForumDispatch

开放论坛事件的 主题事件。

OpenForumThreadUpdate

@SerialName(value = "OPEN_FORUM_THREAD_UPDATE")

data class OpenForumThreadUpdate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: OpenForumThreadData) : OpenForumThreadDispatch

主题事件：更新主题

PublicMessageDeleteCreate

@SerialName(value = "PUBLIC_MESSAGE_DELETE")

data class PublicMessageDeleteCreate(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Unit) : Signal.Dispatch

消息事件 PUBLIC_MESSAGE_DELETE_TYPE

@SerialName(value = "READY")

data class Ready(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: Ready.Data) : Signal.Dispatch

鉴权成功之后，后台会下发的 Ready Event.

sealed interface ReceiveAble

用于标记 Opcode 中对应的往来类型为可接收类型。

@SerialName(value = "RESUMED")

data class Resumed(val id: String? = null, val s: Long = DEFAULT_SEQ, val data: String) : Signal.Dispatch

sealed interface SendAble

用于标记 Opcode 中对应的往来类型为可发送类型。

@Serializable(with = SharedSerializer::class)

data class Shard(val value: Int, val total: Int)

sealed class Signal<D>(val op: Opcode)

Properties

EventIntentsInstances

val ~~EventIntentsInstances~~: Array<EventIntents>

EventIntents 的所有实现类型的数组。

Functions

inline fun Intents(block: IntentsAppenderOp.() -> Unit): Intents

使用 IntentsAppender DSL 构建一个 Intents.

resolveDispatchSerializer

fun resolveDispatchSerializer(eventName: String): KSerializer<out Signal.Dispatch>?

fun resolveDispatchSerializer(json: JsonObject, allowNameMissing: Boolean = false): KSerializer<out Signal.Dispatch>?

解析 json 并寻找匹配的 KSerializerSignal.Dispatch>, 如果找不到则得到 null。

Inherited functions

fun JsonElement.getOpcode(): Int?

获取当前json结构体中的 op 字段。

inline fun IntentsAppender.intents(block: IntentsAppenderOp.() -> Unit)

fun JsonElement.tryGetId(): String?

fun JsonElement.tryGetSeq(): Long?