mirai-core-api/net.mamoe.mirai.event.events

Package-level declarations

Types

abstract class AbstractMessageEvent : AbstractEvent, MessageEvent

消息事件的公共抽象父类, 保留将来使用. 这是内部 API, 请不要使用.

data class BeforeImageUploadEvent @MiraiInternalApi constructor(val target: Contact, val source: ExternalResource) : AbstractEvent, BotEvent, BotActiveEvent, CancellableEvent, VerboseEvent

图片上传前. 可以阻止上传.

BeforeShortVideoUploadEvent

class BeforeShortVideoUploadEvent @MiraiInternalApi constructor(val target: Contact, val thumbnailSource: ExternalResource, val videoSource: ExternalResource) : AbstractEvent, BotEvent, BotActiveEvent, CancellableEvent, VerboseEvent

短视频上传前. 可以阻止上传.

BotActiveEvent

interface BotActiveEvent : BotEvent

由 Bot 主动发起的动作的事件

BotAvatarChangedEvent

data class BotAvatarChangedEvent(val bot: Bot) : AbstractEvent, BotEvent, Packet

Bot 头像被修改（通过其他客户端修改了头像）. 在此事件广播前就已经修改完毕.

BotEvent

interface BotEvent : Event

有关一个 Bot 的事件

BotGroupPermissionChangeEvent

data class BotGroupPermissionChangeEvent @MiraiInternalApi constructor(val group: Group, val origin: MemberPermission, val new: MemberPermission) : AbstractEvent, BotPassiveEvent, GroupEvent, Packet, GroupMemberInfoChangeEvent

Bot 在群里的权限被改变. 操作人一定是群主

BotInvitedJoinGroupRequestEvent

data class BotInvitedJoinGroupRequestEvent @MiraiInternalApi constructor(val bot: Bot, val eventId: Long, val invitorId: Long, val groupId: Long, val groupName: String, val invitorNick: String) : AbstractEvent, BotEvent, Packet, BaseGroupMemberInfoChangeEvent

Bot 被邀请加入一个群.

BotJoinGroupEvent

sealed class BotJoinGroupEvent : AbstractEvent, GroupEvent, BotPassiveEvent, Packet, GroupMemberInfoChangeEvent

Bot 成功加入了一个新群

BotLeaveEvent

sealed class BotLeaveEvent : AbstractEvent, BotEvent, Packet, GroupMemberInfoChangeEvent

机器人被踢出群或在其他客户端主动退出一个群. 在事件广播前 Bot.groups 就已删除这个群.

BotMuteEvent

data class BotMuteEvent @MiraiInternalApi constructor(val durationSeconds: Int, val operator: NormalMember) : AbstractEvent, GroupEvent, Packet, BotPassiveEvent, GroupMemberInfoChangeEvent

Bot 被禁言

BotNickChangedEvent

data class BotNickChangedEvent(val bot: Bot, val from: String, val to: String) : AbstractEvent, BotEvent, Packet

Bot 的昵称被改变事件, 在此事件触发时 bot 已经完成改名

BotOfflineEvent

sealed class BotOfflineEvent : AbstractEvent, BotEvent

Bot 离线时广播的事件. Bot 离线不会关闭 Bot, 只会关闭 Bot 的网络层.

BotOnlineEvent

data class BotOnlineEvent @MiraiInternalApi constructor(val bot: Bot) : AbstractEvent, BotActiveEvent

Bot 登录完成, 好友列表, 群组列表初始化完成

BotPassiveEvent

interface BotPassiveEvent : BotEvent

Bot 被动接收的事件. 这些事件可能与机器人有关

BotReloginEvent

data class BotReloginEvent @MiraiInternalApi constructor(val bot: Bot, val cause: Throwable?) : AbstractEvent, BotEvent, BotActiveEvent

Bot 主动或被动重新登录. 在此事件广播前就已经登录完毕.

BotUnmuteEvent

data class BotUnmuteEvent @MiraiInternalApi constructor(val operator: NormalMember) : AbstractEvent, GroupEvent, Packet, BotPassiveEvent, GroupMemberInfoChangeEvent

Bot 被取消禁言

EventCancelledException

class EventCancelledException : RuntimeException

FriendAddEvent

data class FriendAddEvent @MiraiInternalApi constructor(val friend: Friend) : AbstractEvent, FriendEvent, Packet, FriendInfoChangeEvent

成功添加了一个新好友的事件

FriendAvatarChangedEvent

data class FriendAvatarChangedEvent @MiraiInternalApi constructor(val friend: Friend) : AbstractEvent, FriendEvent, Packet

Friend 头像被修改. 在此事件广播前就已经修改完毕.

FriendDeleteEvent

data class FriendDeleteEvent @MiraiInternalApi constructor(val friend: Friend) : AbstractEvent, FriendEvent, Packet, FriendInfoChangeEvent

好友已被删除或主动删除的事件.

FriendEvent

interface FriendEvent : BotEvent, UserEvent

有关好友的事件

FriendInputStatusChangedEvent

data class FriendInputStatusChangedEvent @MiraiInternalApi constructor(val friend: Friend, val inputting: Boolean) : AbstractEvent, FriendEvent, Packet, VerboseEvent

好友输入状态改变的事件，当开始输入文字、退出聊天窗口或清空输入框时会触发此事件

FriendMessageEvent

class FriendMessageEvent(val sender: Friend, val message: MessageChain, val time: Int) : AbstractMessageEvent, UserMessageEvent, FriendEvent

机器人收到的好友消息的事件

FriendMessagePostSendEvent

data class FriendMessagePostSendEvent @MiraiInternalApi constructor(val target: Friend, val message: MessageChain, val exception: Throwable?, val receipt: MessageReceipt<Friend>?) : UserMessagePostSendEvent<Friend>

在好友消息发送后广播的事件.

FriendMessagePreSendEvent

data class FriendMessagePreSendEvent @MiraiInternalApi constructor(val target: Friend, var message: Message) : UserMessagePreSendEvent

在发送好友消息前广播的事件.

FriendMessageSyncEvent

class FriendMessageSyncEvent : AbstractMessageEvent, FriendEvent, MessageSyncEvent

机器人在其他客户端发送好友消息同步到这个客户端的事件

FriendNickChangedEvent

data class FriendNickChangedEvent @MiraiInternalApi constructor(val friend: Friend, val from: String, val to: String) : AbstractEvent, FriendEvent, Packet, FriendInfoChangeEvent

Friend 昵称改变事件, 在此事件广播时好友已经完成改名

FriendRemarkChangeEvent

data class FriendRemarkChangeEvent @MiraiInternalApi constructor(val friend: Friend, val oldRemark: String, val newRemark: String) : AbstractEvent, FriendEvent, Packet, FriendInfoChangeEvent, BroadcastControllable

好友昵称改变事件. 目前仅支持解析 (来自 PC 端的修改).

GroupAllowAnonymousChatEvent

data class GroupAllowAnonymousChatEvent @MiraiInternalApi constructor(val origin: Boolean, val new: Boolean, val group: Group, val operator: NormalMember?) : AbstractEvent, GroupSettingChangeEvent<Boolean> , Packet, GroupOperableEvent, GroupMemberInfoChangeEvent

群 "匿名聊天" 功能状态改变. 此事件广播前修改就已经完成.

GroupAllowConfessTalkEvent

data class GroupAllowConfessTalkEvent @MiraiInternalApi constructor(val origin: Boolean, val new: Boolean, val group: Group, val isByBot: Boolean) : AbstractEvent, GroupSettingChangeEvent<Boolean> , Packet, GroupMemberInfoChangeEvent

群 "坦白说" 功能状态改变. 此事件广播前修改就已经完成.

GroupAllowMemberInviteEvent

data class GroupAllowMemberInviteEvent @MiraiInternalApi constructor(val origin: Boolean, val new: Boolean, val group: Group, val operator: NormalMember?) : AbstractEvent, GroupSettingChangeEvent<Boolean> , Packet, GroupOperableEvent, GroupMemberInfoChangeEvent

群 "允许群员邀请好友加群" 功能状态改变. 此事件广播前修改就已经完成.

GroupAwareMessageEvent

interface GroupAwareMessageEvent : MessageEvent

来自一个可以知道其 Group 的用户消息

GroupEntranceAnnouncementChangeEvent

data class ~~GroupEntranceAnnouncementChangeEvent~~ @MiraiInternalApi constructor(val origin: String, val new: String, val group: Group, val operator: NormalMember?) : AbstractEvent, GroupSettingChangeEvent<String> , Packet, GroupOperableEvent, GroupMemberInfoChangeEvent

入群公告改变. 此事件广播前修改就已经完成.

GroupEvent

interface GroupEvent : BotEvent

有关群的事件

GroupMemberEvent

interface GroupMemberEvent : GroupEvent, UserEvent

有关群成员的事件

GroupMessageEvent

class GroupMessageEvent(val senderName: String, val permission: MemberPermission, val sender: Member, val message: MessageChain, val time: Int) : AbstractMessageEvent, GroupAwareMessageEvent, MessageEvent, GroupEvent

机器人收到的群消息的事件

GroupMessagePostSendEvent

data class GroupMessagePostSendEvent @MiraiInternalApi constructor(val target: Group, val message: MessageChain, val exception: Throwable?, val receipt: MessageReceipt<Group>?) : MessagePostSendEvent<Group>

在群消息发送后广播的事件.

GroupMessagePreSendEvent

data class GroupMessagePreSendEvent @MiraiInternalApi constructor(val target: Group, var message: Message) : MessagePreSendEvent

在发送群消息前广播的事件.

GroupMessageSyncEvent

class GroupMessageSyncEvent : AbstractMessageEvent, GroupAwareMessageEvent, MessageSyncEvent

机器人在其他客户端发送群消息同步到这个客户端的事件

GroupMuteAllEvent

data class GroupMuteAllEvent @MiraiInternalApi constructor(val origin: Boolean, val new: Boolean, val group: Group, val operator: NormalMember?) : AbstractEvent, GroupSettingChangeEvent<Boolean> , Packet, GroupOperableEvent, GroupMemberInfoChangeEvent

群 "全员禁言" 功能状态改变. 此事件广播前修改就已经完成.

GroupNameChangeEvent

data class GroupNameChangeEvent @MiraiInternalApi constructor(val origin: String, val new: String, val group: Group, val operator: NormalMember?) : AbstractEvent, GroupSettingChangeEvent<String> , Packet, GroupOperableEvent, GroupMemberInfoChangeEvent

群名改变. 此事件广播前修改就已经完成.

GroupOperableEvent

interface GroupOperableEvent : GroupEvent

可由 Member 或 Bot 操作的事件

GroupSettingChangeEvent

interface GroupSettingChangeEvent<T> : GroupEvent, BotPassiveEvent, BroadcastControllable

群设置改变. 此事件广播前修改就已经完成.

GroupTalkativeChangeEvent

data class GroupTalkativeChangeEvent(val group: Group, val now: NormalMember, val previous: NormalMember) : AbstractEvent, Packet, GroupEvent, BotPassiveEvent

Group 龙王改变时的事件

GroupTempMessageEvent

class GroupTempMessageEvent(val sender: NormalMember, val message: MessageChain, val time: Int) : TempMessageEvent, GroupAwareMessageEvent, UserMessageEvent

群临时会话消息

GroupTempMessagePostSendEvent

data class GroupTempMessagePostSendEvent @MiraiInternalApi constructor(val target: NormalMember, val message: MessageChain, val exception: Throwable?, val receipt: MessageReceipt<NormalMember>?) : TempMessagePostSendEvent

在群临时会话消息发送后广播的事件.

GroupTempMessagePreSendEvent

data class GroupTempMessagePreSendEvent @MiraiInternalApi constructor(val target: NormalMember, var message: Message) : TempMessagePreSendEvent

在发送群临时会话消息前广播的事件.

GroupTempMessageSyncEvent

class GroupTempMessageSyncEvent : AbstractMessageEvent, GroupAwareMessageEvent, MessageSyncEvent

机器人在其他客户端发送群临时会话消息同步到这个客户端的事件

ImageUploadEvent

sealed class ImageUploadEvent : AbstractEvent, BotEvent, BotActiveEvent, VerboseEvent

图片上传完成.

MemberCardChangeEvent

data class MemberCardChangeEvent @MiraiInternalApi constructor(val origin: String, val new: String, val member: NormalMember) : AbstractEvent, GroupMemberEvent, Packet, GroupMemberInfoChangeEvent

成员群名片改动. 此事件广播前修改就已经完成.

MemberHonorChangeEvent

@MiraiExperimentalApi

sealed class MemberHonorChangeEvent : AbstractEvent, GroupMemberEvent, BotPassiveEvent, Packet

Member 荣誉改变时的事件, 目前只支持龙王

MemberJoinEvent

sealed class MemberJoinEvent : AbstractEvent, GroupMemberEvent, BotPassiveEvent, Packet, GroupMemberInfoChangeEvent

成员已经加入群的事件

MemberJoinRequestEvent

data class MemberJoinRequestEvent @MiraiInternalApi constructor(val bot: Bot, val eventId: Long, val message: String, val fromId: Long, val groupId: Long, val groupName: String, val fromNick: String, val invitorId: Long? = null) : AbstractEvent, BotEvent, Packet, BaseGroupMemberInfoChangeEvent

一个账号请求加入群事件, Bot 在此群中是管理员或群主.

MemberLeaveEvent

sealed class MemberLeaveEvent : AbstractEvent, GroupMemberEvent, GroupMemberInfoChangeEvent

成员已经离开群的事件. 在事件广播前成员就已经从 Group.members 中删除

MemberMuteEvent

data class MemberMuteEvent @MiraiInternalApi constructor(val member: Member, val durationSeconds: Int, val operator: Member?) : AbstractEvent, GroupMemberEvent, Packet, GroupOperableEvent, GroupMemberInfoChangeEvent

群成员被禁言事件. 被禁言的成员都不可能是机器人本人

MemberPermissionChangeEvent

data class MemberPermissionChangeEvent @MiraiInternalApi constructor(val member: NormalMember, val origin: MemberPermission, val new: MemberPermission) : AbstractEvent, GroupMemberEvent, BotPassiveEvent, Packet, GroupMemberInfoChangeEvent

成员权限改变的事件. 成员不可能是机器人自己.

MemberSpecialTitleChangeEvent

data class MemberSpecialTitleChangeEvent @MiraiInternalApi constructor(val origin: String, val new: String, val member: NormalMember, val operator: NormalMember?) : AbstractEvent, GroupMemberEvent, GroupOperableEvent, Packet, GroupMemberInfoChangeEvent

成员群特殊头衔改动. 一定为群主操作

MemberUnmuteEvent

data class MemberUnmuteEvent @MiraiInternalApi constructor(val member: Member, val operator: Member?) : AbstractEvent, GroupMemberEvent, Packet, GroupOperableEvent, GroupMemberInfoChangeEvent

群成员被取消禁言事件. 被禁言的成员都不可能是机器人本人

MessageEvent

interface MessageEvent : Event, Packet, BotPassiveEvent

一个消息事件.

MessagePostSendEvent

sealed class MessagePostSendEvent<C : Contact> : AbstractEvent, BotEvent, BotActiveEvent, VerboseEvent

在发送消息后广播的事件, 总是在 MessagePreSendEvent 之后广播.

MessagePreSendEvent

sealed class MessagePreSendEvent : AbstractEvent, BotEvent, BotActiveEvent, CancellableEvent, VerboseEvent

在发送消息前广播的事件. 可被取消.

MessageRecallEvent

sealed class MessageRecallEvent : AbstractEvent, BotEvent

消息撤回事件. 可是任意消息被任意人撤回.

MessageSyncEvent

interface MessageSyncEvent : MessageEvent, OtherClientEvent

机器人在其他客户端发送消息同步到这个客户端的事件.

NewFriendRequestEvent

data class NewFriendRequestEvent @MiraiInternalApi constructor(val bot: Bot, val eventId: Long, val message: String, val fromId: Long, val fromGroupId: Long, val fromNick: String) : AbstractEvent, BotEvent, Packet, FriendInfoChangeEvent

一个账号请求添加机器人为好友的事件

NudgeEvent

data class NudgeEvent @MiraiInternalApi constructor(val from: UserOrBot, val target: UserOrBot, val subject: Contact, val action: String, val suffix: String) : AbstractEvent, BotEvent, Packet

戳一戳事件

OtherClientEvent

interface OtherClientEvent : BotEvent, Packet

OtherClientMessageEvent

class OtherClientMessageEvent(val client: OtherClient, val message: MessageChain, val time: Int) : AbstractMessageEvent, MessageEvent, OtherClientEvent

机器人收到的其他客户端消息的事件

OtherClientOfflineEvent

data class OtherClientOfflineEvent(val client: OtherClient) : AbstractEvent, OtherClientEvent, BotPassiveEvent

其他设备离线

OtherClientOnlineEvent

data class OtherClientOnlineEvent @MiraiInternalApi constructor(val client: OtherClient, val kind: ClientKind?) : AbstractEvent, OtherClientEvent, BotPassiveEvent

其他设备上线

ShortVideoUploadEvent

sealed class ShortVideoUploadEvent : AbstractEvent, BotEvent, BotActiveEvent, VerboseEvent

短视频上传完成.

SignEvent

class SignEvent @MiraiInternalApi constructor(val user: UserOrBot, val sign: String, val hasRank: Boolean, val rank: Int?) : AbstractEvent, BotEvent, Packet

打卡事件

StrangerAddEvent

data class StrangerAddEvent @MiraiInternalApi constructor(val stranger: Stranger) : AbstractEvent, StrangerEvent, Packet

新增陌生人的事件

StrangerEvent

interface StrangerEvent : BotEvent, UserEvent

有关陌生人的事件

StrangerMessageEvent

class StrangerMessageEvent(val sender: Stranger, val message: MessageChain, val time: Int) : AbstractMessageEvent, UserMessageEvent, StrangerEvent

机器人收到的陌生人消息的事件

StrangerMessagePostSendEvent

data class StrangerMessagePostSendEvent @MiraiInternalApi constructor(val target: Stranger, val message: MessageChain, val exception: Throwable?, val receipt: MessageReceipt<Stranger>?) : UserMessagePostSendEvent<Stranger>

在陌生人消息发送后广播的事件.

StrangerMessagePreSendEvent

data class StrangerMessagePreSendEvent @MiraiInternalApi constructor(val target: Stranger, var message: Message) : UserMessagePreSendEvent

在发送陌生人消息前广播的事件.

StrangerMessageSyncEvent

class StrangerMessageSyncEvent : AbstractMessageEvent, StrangerEvent, MessageSyncEvent

机器人在其他客户端发送陌生人消息同步到这个客户端的事件

StrangerRelationChangeEvent

sealed class StrangerRelationChangeEvent : AbstractEvent, StrangerEvent, Packet

陌生人关系改变事件

UserEvent

interface UserEvent : BotEvent

有关 User 的事件

UserMessageEvent

interface UserMessageEvent : MessageEvent

来自 User 的消息

UserMessagePostSendEvent

sealed class UserMessagePostSendEvent<C : User> : MessagePostSendEvent<C>

在好友或群临时会话消息发送后广播的事件.

UserMessagePreSendEvent

sealed class UserMessagePreSendEvent : MessagePreSendEvent

在发送好友或群临时会话消息前广播的事件.

Properties

isByBot

val GroupOperableEvent.isByBot: Boolean

是否由 Bot 操作

val MessageRecallEvent.isByBot: Boolean

val MessageRecallEvent.FriendRecall.isByBot: Boolean

isFailure

val MessagePostSendEvent<*>.isFailure: Boolean

在此消息发送失败时返回 true.

isSuccess

val MessagePostSendEvent<*>.isSuccess: Boolean

在此消息发送成功时返回 true.

operatorOrBot

val GroupOperableEvent.operatorOrBot: Member

当操作人为 Member 时获取这个 Member, 当操作人为 Bot 时获取 Group.botAsMember

result

val <C : Contact> MessagePostSendEvent<C>.result: Result<MessageReceipt<C>>

将 MessagePostSendEvent.exception 与 MessagePostSendEvent.receipt 表示为 Result

source

val MessagePostSendEvent<*>.source: MessageSource?

获取指代这条已经发送的消息的 MessageSource. 若消息发送失败, 返回 null

sourceResult

val MessagePostSendEvent<*>.sourceResult: Result<MessageSource>

获取指代这条已经发送的消息的 MessageSource, 并包装为 kotlin.Result