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

MusicShare

@Serializable

data class MusicShare(val kind: MusicKind, val title: String, val summary: String, val jumpUrl: String, val pictureUrl: String, val musicUrl: String, val brief: String) : MessageContent, ConstrainSingle, CodableMessage

QQ 互联通道音乐分享.

构造实例即可使用.

Since

2.1

Constructors

MusicShare

constructor(kind: MusicKind, title: String, summary: String, jumpUrl: String, pictureUrl: String, musicUrl: String)

constructor(kind: MusicKind, title: String, summary: String, jumpUrl: String, pictureUrl: String, musicUrl: String, brief: String)

Types

Key

object Key : AbstractPolymorphicMessageKey<MessageContent, MusicShare>

注意, baseKey MessageContent 不稳定. 未来可能会有变更.

Functions

appendMiraiCodeTo

@MiraiExperimentalApi

open override fun appendMiraiCodeTo(builder: StringBuilder)

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

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

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

repeat

fun Message.repeat(count: Int): MessageChain

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

sendTo

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

将 this 发送给指定联系人

serializeToMiraiCode

open fun serializeToMiraiCode(): String

转换为 mirai 码.

serializeToMiraiCode

@JvmStatic

fun CodableMessage.serializeToMiraiCode(): String

转换得到 mirai 码.

times

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

fun Message.toMessageChain(): MessageChain

Properties

brief

val brief: String

在消息列表显示. 例如 "[分享]ファッション"

content

val Message.content: String

Message.contentToString 的捷径

jumpUrl

val jumpUrl: String

点击卡片跳转网页 URL. 例如 "http://music.163.com/song/1338728297/?userid=324076307"

key

open override val key: MessageKey<*>

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

kind

val kind: MusicKind

音乐应用类型

musicUrl

val musicUrl: String

音乐文件 URL. 例如 "http://music.163.com/song/media/outer/url?id=1338728297&userid=324076307"

pictureUrl

val pictureUrl: String

消息卡片图片 URL. 例如 "http://p2.music.126.net/y19E5SadGUmSR8SZxkrNtw==/109951163785855539.jpg"

summary

val summary: String

消息卡片内容. 例如 "rinahamu/Yunomi"

title

val title: String

消息卡片标题. 例如 "ファッション"