mirai-core-api/net.mamoe.mirai.message.data/ForwardMessage

ForwardMessage

@Serializable

data class ForwardMessage( val preview: List<String>, val title: String, val brief: String, val source: String, val summary: String, val nodeList: List<ForwardMessage.Node>) : MessageContent, ConstrainSingle

合并转发消息

显示方案

移动端

在移动客户端将会显示为卡片

<title>: DisplayStrategy.generateTitle
<preview>: DisplayStrategy.generatePreview
<summary>: DisplayStrategy.generateSummary

|-------------------------|
| <title>                 |
| <preview>               |
|-------------------------|
| <summary>               |
|-------------------------|

默认显示方案:

|-------------------------|
| 群聊的聊天记录             |
| <消息 1>                 |
| <消息 2>                 |
| <消息 3>                 |
|-------------------------|
| 查看3条转发消息          |
|-------------------------|

PC 端

在部分 PC 端显示为类似移动端的卡片, 在其他 PC 端显示为以下格式

鸽子 A 2020/04/23 11:27:54
咕
鸽子 B 2020/04/23 11:27:55
咕
鸽子 C 1970/01/01 08:00:00
咕咕咕

构造

使用构建器 ForwardMessageBuilder
使用 DSL
通过 MessageEvent 集合转换: toForwardMessage

Constructors

ForwardMessage

constructor(preview: List<String>, title: String, brief: String, source: String, summary: String, nodeList: List<ForwardMessage.Node>)

Types

DisplayStrategy

interface DisplayStrategy

合并转发卡片展示策略. 用于 RawForwardMessage 的渲染.

INode

@MiraiExperimentalApi

interface INode

请构造 Node

Key

object Key : AbstractPolymorphicMessageKey<MessageContent, ForwardMessage>

Node

@Serializable

data class Node(val senderId: Long, val time: Int, val senderName: String, val messageChain: MessageChain) : ForwardMessage.INode

消息节点

Functions

contentEquals

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 相等.

contentToString

open override fun contentToString(): String

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

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

isContentBlank

fun Message.isContentBlank(): Boolean

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

isContentEmpty

fun Message.isContentEmpty(): Boolean

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

plus

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

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

open operator fun plus(another: CharSequence): MessageChain

open operator fun plus(another: String): MessageChain

@JvmName(name = "plusIterableString")

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

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

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

open operator fun plus(another: Message): MessageChain

open operator fun plus(another: MessageChain): MessageChain

open operator fun plus(another: SingleMessage): MessageChain

plus

inline suspend operator fun Message.plus(another: Flow<Message>): MessageChain

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

repeat

inline fun Message.repeat(count: Int): MessageChain

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

sendTo

inline suspend fun <C : Contact> Message.sendTo(contact: C): MessageReceipt<C>

将 this 发送给指定联系人

times

inline operator fun Message.times(count: Int): MessageChain

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

toForwardMessage

@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

toMessageChain