mirai-core-api/net.mamoe.mirai.message.data/OnlineMessageSource/Outgoing/ToFriend

ToFriend

@NotStableForInheritance
abstract class ToFriend @MiraiInternalApi constructor : OnlineMessageSource.Outgoing

Constructors

Link copied to clipboard
@MiraiInternalApi
constructor()

Functions

Link copied to clipboard
open fun contentEquals(another: String, ignoreCase: Boolean = false): Boolean

判断内容是否与 another 相等.

open fun contentEquals(another: Message, ignoreCase: Boolean = false): Boolean

判断内容是否与 another 相等即 this 与 another 的 contentToString 相等.

open fun contentEquals(another: Message, ignoreCase: Boolean = false, strict: Boolean = false): Boolean

判断内容是否与 another 相等即 this 与 another 的 contentToString 相等.

Link copied to clipboard
abstract fun contentToString(): String

转为接近官方格式的字符串, 即 "内容". 如 At(member) + "test" 将转为 "@QQ test".

Link copied to clipboard
@JvmName(name = "copySource")
fun MessageSource.copyAmend(block: MessageSourceAmender.() -> Unit): OfflineMessageSource

复制这个消息源, 并以 block 修改

Link copied to clipboard
open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

Link copied to clipboard
fun Message.isContentBlank(): Boolean

当消息内容为空白时返回 true.

Link copied to clipboard
fun Message.isContentEmpty(): Boolean

当消息内容为空时返回 true.

Link copied to clipboard
open operator fun plus(another: Array<out Message>): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

open operator fun plus(another: CharSequence): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

open operator fun plus(another: String): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

@JvmName(name = "plusIterableString")
open operator fun plus(another: Iterable<String>): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

open operator fun plus(another: Iterable<Message>): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

open operator fun plus(another: Sequence<Message>): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

open operator fun plus(another: Message): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

open operator fun plus(another: MessageChain): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

open operator fun plus(another: SingleMessage): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

Link copied to clipboard
suspend operator fun Message.plus(another: Flow<Message>): MessageChain

将 another 按顺序连接到这个消息的尾部.

Link copied to clipboard
@JvmStatic
fun MessageSource.quote(): QuoteReply

引用这条消息.

Link copied to clipboard
@JvmStatic
suspend fun MessageSource.recall()

以 Bot 身份撤回该消息源指向的存在于服务器上的消息. 可撤回自己 2 分钟内发出的消息, 和任意时间的群成员的消息.

Link copied to clipboard
@JvmStatic
fun MessageSource.recallIn(millis: Long): AsyncRecallResult

在一段时间后撤回这条消息.

Link copied to clipboard
fun Message.repeat(count: Int): MessageChain

将此消息元素按顺序重复 count 次.

Link copied to clipboard
inline suspend fun <C : Contact> Message.sendTo(contact: C): MessageReceipt<C>

将 this 发送给指定联系人

Link copied to clipboard
operator fun Message.times(count: Int): MessageChain

将此消息元素按顺序重复 count 次.

Link copied to clipboard
@JvmOverloads
fun Message.toForwardMessage(sender: User, time: Int = currentTimeSeconds().toInt(), displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage
@JvmOverloads
fun Message.toForwardMessage(senderId: Long, senderName: String, time: Int = currentTimeSeconds().toInt(), displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

转换为 ForwardMessage

Link copied to clipboard
Link copied to clipboard
@JvmName(name = "toOfflineMessageSource")
fun OnlineMessageSource.toOffline(): OfflineMessageSource

将在线消息源转换为离线消息源.

Link copied to clipboard
override fun toString(): String

得到包含 mirai 消息元素代码的, 易读的字符串. 如 At(member) + "test" 将转为 "[mirai:at:qqId]test".

Properties

Link copied to clipboard
abstract val bot: Bot
Link copied to clipboard
val MessageSource.bot: Bot

获取此消息源的相关 Bot.

Link copied to clipboard
override val botId: Long

所属 Bot.id

Link copied to clipboard
val MessageSource.botOrNull: Bot?

获取此消息源的相关 Bot.

Link copied to clipboard
Link copied to clipboard
override val fromId: Long

发送人用户 ID.

Link copied to clipboard
abstract val ids: IntArray

消息 ids (序列号). 在获取失败时 (概率很低) 为空数组.

Link copied to clipboard
abstract val internalIds: IntArray

内部 ids. 仅用于协议模块使用

Link copied to clipboard
abstract val isOriginalMessageInitialized: Boolean

当 originalMessage 已被初始化后返回 true.

Link copied to clipboard
override val key: MessageKey<MessageSource>

用于判断是否为同一种元素的 MessageKey. 使用多态类型 MessageKey 最上层的 MessageKey.

Link copied to clipboard
override val kind: MessageSourceKind

消息种类

Link copied to clipboard
abstract val originalMessage: MessageChain

该消息源指向的原消息的内容.

Link copied to clipboard
abstract override val sender: Bot

消息发送人. 可能为 机器人 或 好友 或 群员. 即类型必定为 Bot, Friend 或 Member

Link copied to clipboard
override val subject: Friend

消息主体. 群消息时为 Group. 好友消息时为 Friend, 临时消息为 Member 不论是机器人接收的消息还是发送的消息, 此属性都指向机器人能进行回复的目标.

Link copied to clipboard
abstract override val target: Friend

消息发送目标. 可能为 机器人 或 好友 或 群. 即类型必定为 Bot, Friend 或 Group

Link copied to clipboard
override val targetId: Long

消息发送目标用户或群号码.

Link copied to clipboard
abstract val time: Int

发送时间时间戳, 单位为秒.