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

MessageEvent

interface MessageEvent : Event, Packet, BotPassiveEvent

一个消息事件.

实用扩展

在处理事件时, 以下可能有用 (Kotlin).

挂起协程直到监听下一条事件

通过 MessageEvent.nextMessage 可在全局事件通道中监听并获取下一条符合条件的消息事件. 这可能帮助实现向用户请求一条更详细的输入等功能.

判断语境相同

使用 MessageEvent.isContextIdenticalWith 可判断两个 MessageEvent 的语境是否相同. 有关"语境"的定义可查看 MessageEvent.isContextIdenticalWith.

Inheritors

UserMessageEvent

OtherClientMessageEvent

GroupAwareMessageEvent

GroupMessageEvent

AbstractMessageEvent

MessageSyncEvent

Functions

buildForwardMessage

inline fun MessageEvent.buildForwardMessage(context: Contact = this.subject, displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy, block: ForwardMessageBuilder.() -> Unit): ForwardMessage

使用 DSL 构建一个 ForwardMessage.

abstract fun intercept()

拦截这个事件

isContextIdenticalWith

fun MessageEvent.isContextIdenticalWith(another: MessageEvent): Boolean

判断两个 MessageEvent 的语境, 即 MessageEvent.sender 和 MessageEvent.subject 是否相同

Properties

abstract override val bot: Bot

与这个消息事件相关的 Bot

abstract val isIntercepted: Boolean

事件是否已被拦截.

abstract val message: MessageChain

消息内容.

abstract val sender: User

发送人.

abstract val senderName: String

发送人名称. 由群员发送时为群员名片, 由好友发送时为好友昵称. 使用 User.nameCardOrNick 也能得到相同的结果.

open val source: OnlineMessageSource.Incoming

消息源. 来自 message. 相当于对 message 以 MessageSource 参数调用 MessageChain.get.

abstract val subject: Contact

消息事件主体.

abstract val time: Int

消息发送时间戳, 单位为秒. 由服务器提供, 可能与本地有时差.