事件 Event
基本事件类型
事件类型中, 比较基础、接近根部的类型。
- Event
事件。是所有事件类型的老父亲。
属性:
- id
ID类型, 事件的ID。根据不同的场景, 它可能是真实的, 也可能是随机的。
- time
Timestamp类型, 事件发生的时间或此事件被接收到的时间。
- ComponentEvent
代表一个含有
Component信息的事件。属性:
- component
Component类型, 事件所属组件的组件标识。
- BotEvent
继承
ComponentEvent, 代表一个含有Bot的事件。属性:
- bot
Bot类型, 事件所属或源自的Bot。
- ContentEvent
存在一个 主要事件中心 (
content) 的事件类型。属性:
- content
Any?类型, 也就是可能为任何类型, 代表这个事件的主要事件中心。
- SourceEvent
存在一个 源头 (
source) 的事件类型。 通常与ContentEvent配合实现。属性:
- source
Any?类型, 也就是可能为任何类型, 代表这个事件的 “源头”。
- ChangeEvent
继承
ContentEvent, 发生了某种变化的事件。属性:
- content
Any?类型, 也就是可能为任何类型, 代表这个事件的 发生了变化的主体。。
行为对象 Actor 相关事件
一些与 行为对象 相关、并将其视为事件中心的事件类型。
- ActorEvent
所有行为对象事件的统一父类, 继承 BotEvent、 ContentEvent。
属性:
- content
Actor类型, 被作为事件中心的 行为对象。
- ContactEvent
以 联系人 为中心的事件。
属性:
- content
Contact类型, 被作为事件中心的 联系人。
- OrganizationEvent
以 组织 为中心的事件。
属性:
- content
Organization类型, 被作为事件中心的 组织。
- ChatRoomEvent
以 聊天室 为中心的事件。
属性:
- content
ChatRoom类型, 被作为事件中心的 聊天室。
- ChatGroupEvent
以 聊天群 为中心的事件。
属性:
- content
ChatGroup类型, 被作为事件中心的 聊天群。
- GuildEvent
以 频道服务器 为中心的事件。
属性:
- content
Guild类型, 被作为事件中心的 频道服务器。
- ChannelEvent
以 频道 为中心的事件。
属性:
- source
Guild类型, 此事件中心的频道所属的 频道服务器。- content
Channel类型, 被作为事件中心的 频道。
- ChatChannelEvent
以 聊天频道 为中心的事件。
属性:
- source
Guild类型, 此事件中心的频道所属的 频道服务器。- content
ChatChannel类型, 被作为事件中心的 聊天频道。
- OrganizationSourceEvent
以 组织 作为源头、但并非事件主要主体的事件类型。
属性:
- source
Organization类型, 事件中心的所属源头 组织。
- MemberEvent
以 组织成员 为中心的事件。
属性:
- source
Organization类型, 此事件中心的组织成员所属的源头 组织。- content
Member类型, 被作为事件中心的 组织成员。
- ChatGroupMemberEvent
以一个 聊天群 中的 组织成员 为中心的事件。
属性:
- source
ChatGroup类型, 此事件中心的组织成员所属的源头 聊天群。- content
Member类型, 被作为事件中心的 组织成员。
- GuildMemberEvent
以一个 频道 中的 组织成员 为中心的事件。
属性:
- source
Guild类型, 此事件中心的组织成员所属的源头 频道。- content
Member类型, 被作为事件中心的 组织成员。
请求相关事件
一些与申请、请求或相似概念相关的事件类型。
- RequestEvent
Bot收到的某种与请求/申请有关的事件。继承 BotEvent。- message
String?类型, 伴随请求的附加消息。可能为null。- type
RequestEvent.Type枚举类型, 此申请的主动或被动类型。元素:
PROACTIVEPASSIVE
- reject()
拒绝此请求。
- accept()
接受此请求。
- OrganizationRequestEvent
Bot收到的某种与 组织 相关的请求/申请有关的事件。- OrganizationJoinRequestEvent
某个用户想要加入目标 组织 的请求事件。
- requesterId
ID类型, 申请人的 ID。- requester
User?类型, 尝试获取申请者的一些基础信息。 如果无法获取则可能为null。
- ChatGroupJoinRequestEvent
某用户申请加入 聊天群 的事件。
- content
ChatGroup类型, 被申请的 聊天群。
- GuildJoinRequestEvent
某用户申请加入 频道 的事件。
- content
Guild类型, 被申请的 频道。
成员变动事件
一些与 组织成员 发生了变化、变动或相似概念相关的事件类型。
- MemberChangeEvent
当 组织成员 发生了某种变化时的事件。
- content
Member类型, 发生了变化的 组织成员。
- GuildMemberChangeEvent
当 频道 的 组织成员 发生了某种变化时的事件。
继承 GuildMemberEvent。
- source
Guild类型, 发生变化所在的 频道。- content
Member类型, 发生了变化的 组织成员。
- GroupMemberChangeEvent
当 聊天群 的 组织成员 发生了某种变化时的事件。
继承 GroupMemberEvent。
- source
ChatGroup类型, 发生变化所在的 聊天群。- content
Member类型, 发生了变化的 组织成员。
组织变动事件
一些与 组织 发生了变化、变动或相似概念相关的事件类型。
- OrganizationChangeEvent
某 组织 产生了某种变化的事件。
继承 ChangeEvent, OrganizationEvent。
- content
Organization类型, 发生了变化的 组织。
- MemberIncreaseOrDecreaseEvent
某组织成员增加或减少的事件。
- content
Organization类型, 增加或减少成员的 组织。返回类型会根据实现类的场景而变化。
- member
Member?类型, 增加或减少的 组织成员。 如不支持获取, 则可能得到 null 。
- MemberIncreaseEvent
某组织成员增加事件。继承
MemberIncreaseOrDecreaseEvent。- MemberDecreaseEvent
某组织成员减少事件。继承
MemberIncreaseOrDecreaseEvent。- ChatGroupMemberIncreaseOrDecreaseEvent
某 聊天群 成员变动事件。
- ChatGroupMemberIncreaseEvent
某 聊天群 成员增加事件。继承
ChatGroupMemberIncreaseOrDecreaseEvent。- ChatGroupMemberDecreaseEvent
某 聊天群 成员减少事件。继承
ChatGroupMemberIncreaseOrDecreaseEvent。- GuildMemberIncreaseOrDecreaseEvent
某 频道 成员变动事件。
- GuildMemberIncreaseEvent
某 频道 成员增加事件。继承
GuildMemberIncreaseOrDecreaseEvent。- GuildMemberDecreaseEvent
某 频道 成员减少事件。继承
GuildMemberIncreaseOrDecreaseEvent。
消息事件
一些与Bot收到消息相关的事件类型。
- MessageEvent
一个
Bot收到消息的事件。继承 BotEvent、ReplySupport。- authorId
ID类型, 这个消息的发送人ID。- messageContent
MessageContent类型, 事件中收到的消息内容。- reply(...)
基于此事件收到的消息进行回复。 来自
ReplySupport接口。
- ChatRoomMessageEvent
一个
Bot从 聊天室 处收到消息的事件。- ChatGroupMessageEvent
一个
Bot从 聊天群 处收到消息的事件。- ChatChannelMessageEvent
一个
Bot从 聊天频道 处收到消息的事件。- MemberMessageEvent
一个
Bot从 组织成员 处收到消息的事件。- ChatGroupMemberMessageEvent
一个
Bot从 聊天群 中的 组织成员 处收到消息的事件。- GuildMemberMessageEvent
一个
Bot从 频道 中的 组织成员 处收到消息的事件。- ContactMessageEvent
一个
Bot从 联系人 处收到消息的事件。
内部事件
一些仅在内部流转、与外界无关的事件,通常用于一些内部的状态通知或功能拦截。
InternalEvent
- InternalEvent
一些仅在内部流转、与外界无关的事件,通常用于一些内部的状态通知或功能拦截。
- InternalNotificationEvent
一个内部通知事件。 通知性质的内部事件通常仅用作“通知”,即它不会对某些行为造成影响。
- InternalInterceptionEvent
一个内部拦截事件。
拦截性质的内部事件通常用作“拦截”,即它会对某些行为进行拦截,并有可能会产生影响, 例如改变原本行为的参数、或者通过抛出异常直接阻止某些行为的发生。
BotStageEvent
- BotStageEvent
与 Bot 相关的阶段性事件。 例如bot被注册了、bot被启动了。
继承 InternalEvent, BotEvent。
- BotRegisteredEvent
当一个 Bot 已经在某个
BotManager中被注册后的事件。- BotStartedEvent
当一个 Bot **首次** 启动成功后的事件。
InternalMessageInteractionEvent 内部消息行为事件
- InternalMessageInteractionEvent
在内部一个跟
Message的交互有关的事件。继承 InternalEvent。
- InternalMessagePreSendEvent
针对消息交互时的内部拦截事件,可以对其中的参数进行修改。
- InternalMessagePostSendEvent
针对消息发送 (例如
SendSupport.send或ReplySupport.reply) 成功后的内部通知事件。 会在相关API执行成功后带着它的相关结果进行异步通知
SendSupportInteractionEvent SendSupport 行为事件
- SendSupportInteractionEvent
针对
SendSupport的内部交互事件,包括送信前的拦截与送信成功后的通知。- SendSupportPreSendEvent
针对
SendSupport.send的内部拦截事件。可以对其中的参数进行修改。- SendSupportPostSendEvent
针对
SendSupport.send的内部通知事件。会在SendSupport.send执行成功后带着它的相关结果进行异步通知。
- ContactInteractionEvent
针对
Contact.send的内部交互事件。- ContactPreSendEvent
针对
Contact.send的内部交互事件, 在Contact.send执行前拦截。- ContactPostSendEvent
针对
Contact.send的内部交互事件, 在Contact.send执行后通知。
- MemberInteractionEvent
- MemberPreSendEvent
针对
Member.send的内部交互事件, 在Member.send执行前拦截。- MemberPostSendEvent
针对
Member.send的内部交互事件, 在Member.send执行后通知。
- ChatRoomInteractionEvent
针对
ChatRoom的内部交互事件。- ChatRoomPreSendEvent
针对
ChatRoom.send的内部交互事件, 在ChatRoom.send执行前拦截。- ChatRoomPostSendEvent
针对
ChatRoom.send的内部交互事件, 在ChatRoom.send执行后通知。- ChatGroupInteractionEvent
针对
ChatGroup的内部交互事件- ChatGroupPreSendEvent
针对
ChatGroup.send的内部交互事件, 在ChatGroup.send执行前拦截。- ChatGroupPostSendEvent
针对
ChatGroup.send的内部交互事件, 在ChatGroup.send执行后通知。- ChatChannelInteractionEvent
针对
ChatChannel的内部交互事件- ChatChannelPreSendEvent
针对
ChatChannel.send的内部交互事件, 在ChatChannel.send执行前拦截。- ChatChannelPostSendEvent
针对
ChatChannel.send的内部交互事件, 在ChatChannel.send执行后通知。
ReplySupportInteractionEvent ReplySupport 行为事件
- ReplySupportInteractionEvent
针对
ReplySupport的内部交互事件,包括送信前的拦截与送信成功后的通知。- ReplySupportPreReplyEvent
针对
ReplySupport.reply的内部拦截事件。 可以对其中的参数进行修改。- ReplySupportPostReplyEvent
针对
ReplySupport.reply的内部通知事件。 会在ReplySupport.reply执行成功后带着它的相关结果进行异步通知。
- MessageEventInteractionEvent
针对
MessageEvent.reply的内部交互事件。- MessageEventPreReplyEvent
针对
MessageEvent.reply的内部拦截事件。 可以对其中的参数进行修改。- MessageEventPostReplyEvent
针对
MessageEvent.reply的内部通知事件。 会在MessageEvent.reply执行成功后带着它的相关结果进行异步通知。
- ContactMessageEventInteractionEvent
针对
ContactMessageEvent.reply的内部交互事件。- ContactMessageEventPreReplyEvent
针对
ContactMessageEvent.reply的拦截事件。- ContactMessageEventPostReplyEvent
针对
ContactMessageEvent.reply的通知事件。
- ChatRoomMessageEventInteractionEvent
针对
ChatRoomMessageEvent.reply的内部交互事件。- ChatRoomMessageEventPreReplyEvent
针对
ChatRoomMessageEvent.reply的拦截事件。- ChatRoomMessageEventPostReplyEvent
针对
ChatRoomMessageEvent.reply的通知事件。
- MemberMessageEventInteractionEvent
针对
MemberMessageEvent.reply的内部交互事件。- MemberMessageEventPreReplyEvent
针对
MemberMessageEvent.reply的拦截事件。- MemberMessageEventPostReplyEvent
针对
MemberMessageEvent.reply的通知事件。
- GuildMemberMessageEventInteractionEvent
针对
GuildMemberMessageEvent.reply的内部交互事件。- GuildMemberMessageEventPreReplyEvent
针对
GuildMemberMessageEvent.reply的拦截事件。- GuildMemberMessageEventPostReplyEvent
针对
GuildMemberMessageEvent.reply的通知事件。
- ChatGroupMemberMessageEventInteractionEvent
针对
ChatGroupMemberMessageEvent.reply的内部交互事件。- ChatGroupMemberMessageEventPreReplyEvent
针对
ChatGroupMemberMessageEvent.reply的拦截事件。- ChatGroupMemberMessageEventPostReplyEvent
针对
ChatGroupMemberMessageEvent.reply的通知事件。