Simple Robot v4.7.0 Help

事件定义列表

QQ频道组件中的事件类型包含两个层面：

  1. API 模块 中，对 QQ频道 API 中官方定义的事件结构的基本封装与实现。

  2. 核心模块 中，基于 API 模块中的事件封装，对 simbot4 标准库中的 Event 事件类型的实现。

API 模块事件封装

API 模块所有的事件封装类型都在包 love.forte.simbot.qguild.event 中， 并且基本上命名与官网API中的事件类型名称有一定关联。

所有事件封装类型均继承密封类 love.forte.simbot.qguild.event.Signal.Dispatch。

Ready

love.forte.simbot.qguild.event.Ready

事件类型名: "READY"

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

Resumed

love.forte.simbot.qguild.event.Resumed

事件类型名: "RESUMED"

4.恢复连接 恢复成功之后，就开始补发遗漏事件，所有事件补发完成之后，会下发一个 Resumed Event

C2CManagementDispatch

love.forte.simbot.qguild.event.C2CManagementDispatch

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

FriendAdd

love.forte.simbot.qguild.event.FriendAdd

事件类型名: "FRIEND_ADD"

用户添加机器人 触发场景 用户添加机器人'好友'到消息列表

FriendDel

love.forte.simbot.qguild.event.FriendDel

事件类型名: "FRIEND_DEL"

用户删除机器人 触发场景 用户删除机器人'好友'

C2CMsgReject

love.forte.simbot.qguild.event.C2CMsgReject

事件类型名: "C2C_MSG_REJECT"

拒绝机器人主动消息 触发场景 用户在机器人资料卡手动关闭"主动消息"推送

C2CMsgReceive

love.forte.simbot.qguild.event.C2CMsgReceive

事件类型名: "C2C_MSG_RECEIVE"

允许机器人主动消息 触发场景 用户在机器人资料卡手动开启"主动消息"推送开关

C2CMessageCreate

love.forte.simbot.qguild.event.C2CMessageCreate

事件类型名: "C2C_MESSAGE_CREATE"

单聊消息 触发场景 用户在单聊发送消息给机器人

GroupAtMessageCreate

love.forte.simbot.qguild.event.GroupAtMessageCreate

事件类型名: "GROUP_AT_MESSAGE_CREATE"

群聊@机器人 触发场景 用户在群聊@机器人发送消息

ChannelDispatch

love.forte.simbot.qguild.event.ChannelDispatch

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

ChannelCreate

love.forte.simbot.qguild.event.ChannelCreate

事件类型名: "CHANNEL_CREATE"

子频道事件 CHANNEL_CREATE

发送时机

  • 子频道被创建

ChannelUpdate

love.forte.simbot.qguild.event.ChannelUpdate

事件类型名: "CHANNEL_UPDATE"

子频道事件 CHANNEL_UPDATE

发送时机

  • 子频道信息变更

ChannelDelete

love.forte.simbot.qguild.event.ChannelDelete

事件类型名: "CHANNEL_DELETE"

子频道事件 CHANNEL_DELETE

发送时机

  • 子频道被删除

ForumDispatch

love.forte.simbot.qguild.event.ForumDispatch

论坛事件(ForumEvent)

发送时机

用户在话题子频道内发帖、评论、回复评论时产生该事件

主题事件

  • FORUM_THREAD_CREATE

  • FORUM_THREAD_UPDATE

  • FORUM_THREAD_DELETE 事件内容为 Thread 对象

帖子事件

  • FORUM_POST_CREATE

  • FORUM_POST_DELETE 事件内容为 Post 对象

回复事件

  • FORUM_REPLY_CREATE

  • FORUM_REPLY_DELETE 事件内容为 Reply 对象

帖子审核事件

  • FORUM_PUBLISH_AUDIT_RESULT 事件内容为 AuditResult 对象

ForumThreadDispatch

love.forte.simbot.qguild.event.ForumThreadDispatch

论坛事件：主题事件

ForumThreadCreate

love.forte.simbot.qguild.event.ForumThreadCreate

事件类型名: "FORUM_THREAD_CREATE"

主题创建事件。

ForumThreadUpdate

love.forte.simbot.qguild.event.ForumThreadUpdate

事件类型名: "FORUM_THREAD_UPDATE"

主题更新事件。

ForumThreadDelete

love.forte.simbot.qguild.event.ForumThreadDelete

事件类型名: "FORUM_THREAD_DELETE"

主题删除事件。

ForumPostDispatch

love.forte.simbot.qguild.event.ForumPostDispatch

论坛事件：帖子事件

ForumPostCreate

love.forte.simbot.qguild.event.ForumPostCreate

事件类型名: "FORUM_POST_CREATE"

帖子创建事件

ForumPostDelete

love.forte.simbot.qguild.event.ForumPostDelete

事件类型名: "FORUM_POST_DELETE"

帖子删除事件

ForumReplyDispatch

love.forte.simbot.qguild.event.ForumReplyDispatch

论坛事件：回复事件

ForumReplyCreate

love.forte.simbot.qguild.event.ForumReplyCreate

事件类型名: "FORUM_REPLY_CREATE"

回复创建事件

ForumReplyDelete

love.forte.simbot.qguild.event.ForumReplyDelete

事件类型名: "FORUM_REPLY_DELETE"

回复删除事件

ForumPublishAuditResult

love.forte.simbot.qguild.event.ForumPublishAuditResult

事件类型名: "FORUM_PUBLISH_AUDIT_RESULT"

帖子审核事件

GroupRobotManagementDispatch

love.forte.simbot.qguild.event.GroupRobotManagementDispatch

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

GroupAddRobot

love.forte.simbot.qguild.event.GroupAddRobot

事件类型名: "GROUP_ADD_ROBOT"

机器人加入群聊 触发场景 机器人被添加到群聊

GroupDelRobot

love.forte.simbot.qguild.event.GroupDelRobot

事件类型名: "GROUP_DEL_ROBOT"

机器人退出群聊 触发场景 机器人被移出群聊

GroupMsgReject

love.forte.simbot.qguild.event.GroupMsgReject

事件类型名: "GROUP_MSG_REJECT"

群聊拒绝机器人主动消息 触发场景 群管理员主动在机器人资料页操作关闭通知

GroupMsgReceive

love.forte.simbot.qguild.event.GroupMsgReceive

事件类型名: "GROUP_MSG_RECEIVE"

群聊接受机器人主动消息 触发场景 群管理员主动在机器人资料页操作开启通知

EventGuildDispatch

love.forte.simbot.qguild.event.EventGuildDispatch

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

GuildCreate

love.forte.simbot.qguild.event.GuildCreate

事件类型名: "GUILD_CREATE"

GUILD_CREATE

发送时机

  • 机器人被加入到某个频道的时候

GuildUpdate

love.forte.simbot.qguild.event.GuildUpdate

事件类型名: "GUILD_UPDATE"

GUILD_UPDATE

发送时机

  • 频道信息变更

  • 事件内容为变更后的数据

GuildDelete

love.forte.simbot.qguild.event.GuildDelete

事件类型名: "GUILD_DELETE"

GUILD_DELETE

发送时机

  • 频道被解散

  • 机器人被移除

  • 事件内容为变更前的数据

GuildMemberAdd

love.forte.simbot.qguild.event.GuildMemberAdd

事件类型名: "GUILD_MEMBER_ADD"

GUILD_MEMBER_ADD

发送时机

  • 新用户加入频道

GuildMemberUpdate

love.forte.simbot.qguild.event.GuildMemberUpdate

事件类型名: "GUILD_MEMBER_UPDATE"

GUILD_MEMBER_UPDATE

发送时机

  • 用户的频道属性发生变化，如频道昵称，或者身份组

GuildMemberRemove

love.forte.simbot.qguild.event.GuildMemberRemove

事件类型名: "GUILD_MEMBER_REMOVE"

GUILD_MEMBER_REMOVE

发送时机

  • 用户离开频道

MessageDispatch

love.forte.simbot.qguild.event.MessageDispatch

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

AtMessageCreate

love.forte.simbot.qguild.event.AtMessageCreate

事件类型名: "AT_MESSAGE_CREATE"

消息事件 AT_MESSAGE_CREATE（intents PUBLIC_GUILD_MESSAGES）

发送时机

  • 用户发送消息，@当前机器人或回复机器人消息时

  • 为保障消息投递的速度，消息顺序我们虽然会尽量有序，但是并不保证是严格有序的， 如开发者对消息顺序有严格有序的需求，可以自行缓冲消息事件之后，基于 seq 进行排序

PublicMessageDeleteCreate

love.forte.simbot.qguild.event.PublicMessageDeleteCreate

事件类型名: "PUBLIC_MESSAGE_DELETE"

消息事件 PUBLIC_MESSAGE_DELETE_TYPE

DirectMessageCreate

love.forte.simbot.qguild.event.DirectMessageCreate

事件类型名: "DIRECT_MESSAGE_CREATE"

私信消息事件 DIRECT_MESSAGE_CREATE (intents DIRECT_MESSAGE)

发送时机

  • 用户通过私信发消息给机器人时

MessageAuditedDispatch

love.forte.simbot.qguild.event.MessageAuditedDispatch

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

MessageCreate

love.forte.simbot.qguild.event.MessageCreate

事件类型名: "MESSAGE_CREATE"

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

MessageDelete

love.forte.simbot.qguild.event.MessageDelete

事件类型名: "MESSAGE_DELETE"

删除（撤回）消息事件

MessageAuditPass

love.forte.simbot.qguild.event.MessageAuditPass

事件类型名: "MESSAGE_AUDIT_PASS"

消息审核事件 MESSAGE_AUDIT_PASS（intents MESSAGE_AUDIT）

发送时机

  • 消息审核通过

MessageAuditReject

love.forte.simbot.qguild.event.MessageAuditReject

事件类型名: "MESSAGE_AUDIT_REJECT"

消息审核事件 MESSAGE_AUDIT_REJECT（intents MESSAGE_AUDIT）

发送时机

  • 消息审核不通过

OpenForumDispatch

love.forte.simbot.qguild.event.OpenForumDispatch

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

发送时机

用户在话题子频道内发帖、评论、回复评论时产生该事件

主题事件

  • OPEN_FORUM_THREAD_CREATE

  • OPEN_FORUM_THREAD_UPDATE

  • OPEN_FORUM_THREAD_DELETE 参考 OpenForumThreadDispatch

帖子（评论）事件

  • OPEN_FORUM_POST_CREATE

  • OPEN_FORUM_POST_DELETE 参考 OpenForumPostDispatch

回复事件

  • OPEN_FORUM_REPLY_CREATE

  • OPEN_FORUM_REPLY_DELETE 参考 OpenForumReplyDispatch

OpenForumThreadDispatch

love.forte.simbot.qguild.event.OpenForumThreadDispatch

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

OpenForumThreadCreate

love.forte.simbot.qguild.event.OpenForumThreadCreate

事件类型名: "OPEN_FORUM_THREAD_CREATE"

主题事件：创建主题

OpenForumThreadUpdate

love.forte.simbot.qguild.event.OpenForumThreadUpdate

事件类型名: "OPEN_FORUM_THREAD_UPDATE"

主题事件：更新主题

OpenForumThreadDelete

love.forte.simbot.qguild.event.OpenForumThreadDelete

事件类型名: "OPEN_FORUM_THREAD_DELETE"

主题事件：删除主题

OpenForumPostDispatch

love.forte.simbot.qguild.event.OpenForumPostDispatch

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

OpenForumPostCreate

love.forte.simbot.qguild.event.OpenForumPostCreate

事件类型名: "OPEN_FORUM_POST_CREATE"

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

OpenForumPostDelete

love.forte.simbot.qguild.event.OpenForumPostDelete

事件类型名: "OPEN_FORUM_POST_DELETE"

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

OpenForumReplyDispatch

love.forte.simbot.qguild.event.OpenForumReplyDispatch

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

OpenForumReplyCreate

love.forte.simbot.qguild.event.OpenForumReplyCreate

事件类型名: "OPEN_FORUM_REPLY_CREATE"

回复事件：创建回复

OpenForumReplyDelete

love.forte.simbot.qguild.event.OpenForumReplyDelete

事件类型名: "OPEN_FORUM_REPLY_DELETE"

回复事件：删除回复

API 模块事件封装可以使用在 标准库模块 (stdlib) 中，使用 Bot 类型对他们进行监听与处理。

组件模块的标准 Event 实现

使用核心库，可以在 simbot4 的 Application 或 Spring Boot 中使用这些事件类型实现。

核心模块所有的 simbot Event 实现类型定义都在包 love.forte.simbot.component.qguild.event 中。

所有实现类型均继承 love.forte.simbot.qguild.component.event.QGEvent。

QGChannelCreateEvent

子频道创建事件

QGChannelUpdateEvent

子频道修改事件

QGChannelDeleteEvent

子频道删除事件

QGForumThreadCreateEvent

主题创建事件

QGForumThreadUpdateEvent

主题更新事件

QGForumThreadDeleteEvent

主题删除事件

QGForumPostCreateEvent

帖子创建事件

QGForumPostDeleteEvent

帖子删除事件

QGForumReplyCreateEvent

回复创建事件

QGForumReplyDeleteEvent

回复删除事件

QGForumPublishAuditResultEvent

帖子审核事件

QGGuildCreateEvent

新用户加入频道事件

QGGuildUpdateEvent

用户的频道属性发生变化事件

QGGuildDeleteEvent

用户离开频道事件

QGMemberAddEvent

新用户加入频道事件

QGMemberUpdateEvent

用户的频道属性发生变化事件

QGMemberRemoveEvent

用户离开频道事件

QGAtMessageCreateEvent

收到公域at消息事件

QGOpenForumThreadCreateEvent

"开放"创建主题事件

QGOpenForumThreadUpdateEvent

"开放"更新主题事件

QGOpenForumThreadDeleteEvent

"开放"删除主题事件

QGOpenForumPostCreateEvent

"开放"帖子创建(评论)事件

QGOpenForumPostDeleteEvent

"开放"帖子删除(评论)事件

QGOpenForumReplyCreateEvent

"开放"回复创建事件

QGOpenForumReplyDeleteEvent

"开放"回复删除事件

QGGroupAtMessageCreateEvent

群at消息事件

QGGroupAddRobotEvent

机器人加入群聊事件

QGGroupDelRobotEvent

机器人退出群聊事件

QGGroupMsgRejectEvent

群聊拒绝机器人主动消息事件

QGGroupMsgReceiveEvent

群聊接受机器人主动消息事件

QGC2CMessageCreateEvent

C2C单聊消息事件

QGFriendAddEvent

用户添加机器人事件

QGFriendDelEvent

用户删除机器人事件

QGC2CMsgRejectEvent

拒绝机器人主动消息事件

QGC2CMsgReceiveEvent

允许机器人主动消息事件

QGUnsupportedEvent

特殊的事件类型，用于包装兼容那些尚未被封装支持的 API 模块的事件封装类型。

Last modified: 15 November 2024
API定义列表行为对象