事件

公告

站点迁移啦~！

为什么迁移?

作为由我们官方维护的组件库，分散在各自的文档站点中的确有好处：它们可以各自维护自己所需的东西、互不干扰。

但是缺点也很明显：太过分散。

组件库与核心库之间的关系是比较紧密的，我们希望你能够在一个站点内就可以查阅或搜索到所有你想要得知的信息。

原始事件

我们根据 OneBot11 协议中定义的所有事件结构，在模块 simbot-component-onebot-v11-event 中提供了所有的实现类型。它们是最基础的可序列化数据类，不含有任何功能。

元事件 RawMetaEvent

RawHeartbeatEvent
RawLifecycleEvent

消息事件 RawMessageEvent

RawGroupMessageEvent
RawPrivateMessageEvent

请求事件 RawRequestEvent

RawFriendRequestEvent
RawGroupRequestEvent

通知事件 RawNoticeEvent

RawFriendAddEvent
RawFriendRecallEvent
RawGroupAdminEvent
RawGroupBanEvent
RawGroupDecreaseEvent
RawGroupIncreaseEvent
RawGroupRecallEvent
RawGroupUploadEvent
RawNotifyEvent

未知事件 UnknownEvent

一个特殊的事件类型。它是当遇到无法被上述这些类型所解析时使用的兜底类型，它不可序列化，除 time、 selfId、 postType 之外直接提供 raw 属性(也就是原始的JSON字符串)。

组件事件

组件实现是基于simbot标准API中定义的事件类型、对上述原始事件的包装，并提供相对应的功能性API实现。

OneBotMessageEvent

与消息相关的事件。

OneBotGroupMessageEvent

与群消息相关的事件。

OneBotNormalGroupMessageEvent: 与普通群消息相关的事件。
OneBotAnonymousGroupMessageEvent: 与匿名群消息相关的事件。
OneBotNoticeGroupMessageEvent: 与群系统消息通知相关的事件。

OneBotPrivateMessageEvent

与私聊消息相关的事件。

OneBotFriendMessageEvent: 好友私信消息事件。
OneBotGroupPrivateMessageEvent: 群成员临时会话消息事件。

OneBotMetaEvent

元数据相关的事件

OneBotLifecycleEvent: 生命周期事件
OneBotHeartbeatEvent: 心跳事件

OneBotRequestEvent

请求相关的事件

OneBotFriendRequestEvent: 好友添加申请
OneBotGroupRequestEvent: 群添加申请

OneBotNoticeEvent

通知相关的事件。

OneBotFriendAddEvent: 好友已添加事件
OneBotFriendRecallEvent: 好友消息撤回事件
OneBotGroupAdminEvent: 管理员变动事件
OneBotGroupBanEvent: 群禁言事件
OneBotGroupChangeEvent: 群成员变动事件
OneBotGroupMemberIncreaseEvent: 群成员添加事件
OneBotGroupMemberDecreaseEvent: 群成员离开事件
OneBotGroupRecallEvent: 群消息撤回事件
OneBotGroupUploadEvent: 群文件上传事件
OneBotNotifyEvent: 群荣耀事件、红包人气王事件或戳一戳事件
OneBotHonorEvent: 群荣耀事件
OneBotLuckyKingEvent: 红包人气王事件
OneBotPokeEvent: 戳一戳事件
OneBotMemberPokeEvent: 戳一戳(普通群成员被戳)事件
OneBotBotSelfPokeEvent: 戳一戳(Bot被戳)事件

OneBotBotStageEvent

与OneBot协议本身无关的Bot的阶段事件。

OneBotBotRegisteredEvent: 一个 `OneBotBot` 被注册了的事件
OneBotBotStartedEvent: 一个 `OneBotBot` 被(首次)启动了的事件

未知事件

OneBotUnknownEvent

是对上述原始事件中的 UnknownEvent 类型的包装。

未支持事件

OneBotUnsupportedEvent

是当出现了原始事件中有(除了 UnknownEvent)、但是尚未提供对应的组件事件实现的事件类型时用来兜底的类型。

这些原始事件类型会被统一装入此事件中。

事件关系

简单列举一下原始事件与可能对应的组件事件之间的关系。

原始事件类型	组件事件
`RawMetaEvent`	`OneBotMetaEvent`
> `RawLifecycleEvent`	> `OneBotLifecycleEvent`
> `RawHeartbeatEvent`	> `OneBotHeartbeatEvent`
`RawMessageEvent`	`OneBotMessageEvent`
> `RawGroupMessageEvent`	> `OneBotGroupMessageEvent`
> `RawGroupMessageEvent`	> > `OneBotNormalGroupMessageEvent`
> `RawGroupMessageEvent`	> > `OneBotAnonymousGroupMessageEvent`
> `RawGroupMessageEvent`	> > `OneBotNoticeGroupMessageEvent`
> `RawPrivateMessageEvent`	> `OneBotPrivateMessageEvent`
> `RawPrivateMessageEvent`	> > `OneBotFriendMessageEvent`
> `RawPrivateMessageEvent`	> > `OneBotGroupPrivateMessageEvent`
`RawRequestEvent`	`OneBotRequestEvent`
> `RawFriendRequestEvent`	> `OneBotFriendRequestEvent`
> `RawGroupRequestEvent`	> `OneBotGroupRequestEvent`
`RawNoticeEvent`	`OneBotNoticeEvent`
> `RawFriendAddEvent`	> `OneBotFriendAddEvent`
> `RawFriendRecallEvent`	> `OneBotFriendRecallEvent`
> `RawGroupAdminEvent`	> `OneBotGroupAdminEvent`
> `RawGroupBanEvent`	> `OneBotGroupBanEvent`
> `RawGroupIncreaseEvent` 或 `RawGroupDecreaseEvent`	> `OneBotGroupChangeEvent`
> `RawGroupIncreaseEvent`	> > `OneBotGroupMemberIncreaseEvent`
> `RawGroupDecreaseEvent`	> > `OneBotGroupMemberDecreaseEvent`
> `RawGroupRecallEvent`	> `OneBotGroupRecallEvent`
> `RawGroupUploadEvent`	> `OneBotGroupUploadEvent`
> `RawNotifyEvent`	> `OneBotNotifyEvent`
> `RawNotifyEvent`	> > `OneBotHonorEvent`
> `RawNotifyEvent`	> > `OneBotLuckyKingEvent`
> `RawNotifyEvent`	> > `OneBotPokeEvent`
> `RawNotifyEvent`	> > > `OneBotMemberPokeEvent`
> `RawNotifyEvent`	> > > `OneBotBotSelfPokeEvent`
`UnknownEvent`	> `UnknownEvent`
无	`OneBotBotStageEvent`
无	> `OneBotBotRegisteredEvent`
无	> `OneBotBotStartedEvent`
任意未支持事件	`OneBotUnsupportedEvent`

Last modified: 26 July 2024