事件 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
枚举类型, 此申请的主动或被动类型。元素:
PROACTIVE
PASSIVE
- 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
从 联系人 处收到消息的事件。