mirai/docs/EventList.md
Him188 c03155af6d
Review docs and improve readability (#1291)
* Review docs and improve readability

* Update docs/Bots.md

Co-authored-by: Karlatemp <karlatemp@vip.qq.com>

* Update docs/Bots.md

Co-authored-by: Karlatemp <karlatemp@vip.qq.com>

* Update docs/Bots.md

Co-authored-by: Karlatemp <karlatemp@vip.qq.com>

* Fix doc

* Fix doc

* Clarify AnonymousMember and NormalMember

* Fix typo

* Add language type

Co-authored-by: Karlatemp <karlatemp@vip.qq.com>
2021-06-02 20:29:36 +08:00

104 lines
4.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 事件
## 事件列表一览
提示:
- 在 IntelliJ 平台双击 shift 可输入类名进行全局搜索
- 在 IntelliJ 平台, 按 alt + 7 可打开文件的结构, [效果图](/.github/EZSLAB`K@YFFOW47{090W8B.png)
<!--注释:--> <!--目前还没有这些修改, 因此不展示注释-->
<!--- 此列表自 mirai `2.0.0` 起开始维护, 故在 `2.0.0` 前的变更将不做记录.-->
<!--- 支持某事件的 mirai 版本号将会显式标注, 通过数学区间形式表示, 如 `[1.1.0, 1.3.0)`, 但有简便表示方法:-->
<!-- - (`1.1.0+`) 等注释表示在 `1.1.0` 及更新版本才支持, 区间表示为 `[1.1.0, +∞)`-->
<!-- - (`1.1.0-`) 等注释表示在早于 `1.1.0` 的版本才支持, 区间表示为 `[1.0.0, 1.1.0)`-->
### Bot
- Bot 登录完成: BotOnlineEvent
- Bot 离线: BotOfflineEvent
- 主动: Active
- 被挤下线: Force
- 被服务器断开或因网络问题而掉线: Dropped
- 服务器主动要求更换另一个服务器: RequireReconnect
- Bot 重新登录: BotReloginEvent
- Bot 头像改变: BotAvatarChangedEvent
- Bot 昵称改变: BotNickChangedEvent
- Bot 被戳: BotNudgedEvent
### 消息
- 被动收到消息MessageEvent
- 群消息GroupMessageEvent
- 好友消息FriendMessageEvent
- 群临时会话消息GroupTempMessageEvent
- 陌生人消息StrangerMessageEvent
- 其他客户端消息OtherClientMessageEvent
- 主动发送消息前: MessagePreSendEvent
- 群消息: GroupMessagePreSendEvent
- 好友消息: FriendMessagePreSendEvent
- 群临时会话消息: GroupTempMessagePreSendEvent
- 陌生人消息StrangerMessagePreSendEvent
- 其他客户端消息OtherClientMessagePreSendEvent
- 主动发送消息后: MessagePostSendEvent
- 群消息: GroupMessagePostSendEvent
- 好友消息: FriendMessagePostSendEvent
- 群临时会话消息: GroupTempMessagePostSendEvent
- 陌生人消息StrangerMessagePostSendEvent
- 其他客户端消息OtherClientMessagePostSendEvent
- 消息撤回: MessageRecallEvent
- 好友撤回: FriendRecall
- 群撤回: GroupRecall
- 群临时会话撤回: TempRecall
- 图片上传前: BeforeImageUploadEvent
- 图片上传完成: ImageUploadEvent
- 图片上传成功: Succeed
- 图片上传失败: Failed
- 戳一戳: NudgeEvent
### 群
- 机器人被踢出群或在其他客户端主动退出一个群: BotLeaveEvent
- 机器人主动退出一个群: Active
- 机器人被管理员或群主踢出群: Kick
- 机器人在群里的权限被改变: BotGroupPermissionChangeEvent
- 机器人被禁言: BotMuteEvent
- 机器人被取消禁言: BotUnmuteEvent
- 机器人成功加入了一个新群: BotJoinGroupEvent
#### 群设置
- 群设置改变: GroupSettingChangeEvent
- 群名改变: GroupNameChangeEvent
- 入群公告改变: GroupEntranceAnnouncementChangeEvent
- 全员禁言状态改变: GroupMuteAllEvent
- 匿名聊天状态改变: GroupAllowAnonymousChatEvent
- 允许群员邀请好友加群状态改变: GroupAllowMemberInviteEvent
#### 群成员
##### 成员列表变更
- 成员已经加入群: MemberJoinEvent
- 成员被邀请加入群: Invite
- 成员主动加入群: Active
- 成员已经离开群: MemberLeaveEvent
- 成员被踢出群: Kick
- 成员主动离开群: Quit
- 一个账号请求加入群: MemberJoinRequestEvent
- 机器人被邀请加入群: BotInvitedJoinGroupRequestEvent
##### 名片和头衔
- 成员群名片改动: MemberCardChangeEvent
- 成员群头衔改动: MemberSpecialTitleChangeEvent
##### 成员权限
- 成员权限改变: MemberPermissionChangeEvent
##### 动作
- 群成员被禁言: MemberMuteEvent
- 群成员被取消禁言: MemberUnmuteEvent
### 好友
- 好友昵称改变: FriendRemarkChangeEvent
- 成功添加了一个新好友: FriendAddEvent
- 好友已被删除: FriendDeleteEvent
- 一个账号请求添加机器人为好友: NewFriendRequestEvent
- 好友头像改变: FriendAvatarChangedEvent
- 好友昵称改变: FriendNickChangedEvent
- 好友输入状态改变: FriendInputStatusChangedEvent