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

FriendMessageSyncEvent

class FriendMessageSyncEvent : AbstractMessageEvent, FriendEvent, MessageSyncEvent

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

See also

MessageSyncEvent

Constructors

FriendMessageSyncEvent

constructor(client: OtherClient, sender: Friend, message: MessageChain, time: Int)

constructor(sender: Friend, message: MessageChain, time: Int)

Functions

buildForwardMessage

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

使用 DSL 构建一个 ForwardMessage.

fun cancel()

abstract fun intercept()

拦截这个事件

isContextIdenticalWith

fun MessageEvent.isContextIdenticalWith(another: MessageEvent): Boolean

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

Properties

@MiraiInternalApi

var _intercepted: Boolean

open override val bot: Bot

与这个消息事件相关的 Bot

@MiraiInternalApi

val broadCastLock: Mutex

限制一个事件实例不能并行广播. (适用于 object 广播的情况)

open override val client: OtherClient

open override val friend: Friend

val isCancelled: Boolean

abstract val isIntercepted: Boolean

事件是否已被拦截.

open override val message: MessageChain

消息内容.

open override val sender: Friend

发送人.

open override val senderName: String

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

open override val source: OnlineMessageSource.Incoming.FromFriend

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

open override val subject: Friend

消息事件主体.

open override val time: Int

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

open override val user: Friend