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

OfflineShortVideo

@NotStableForInheritance

interface OfflineShortVideo : ShortVideo

离线短视频消息.

OfflineShortVideo 拥有协议上必要的五个属性:

视频 ID videoId
视频文件名 filename
视频 MD5 fileMd5
视频大小 fileSize
视频格式 fileFormat

和非必要属性：

缩略图 MD5 thumbnailMd5
缩略图大小 thumbnailSize

OfflineShortVideo 可由本地 ExternalResource 经过 AudioSupported.uploadShortVideo 上传到服务器得到, 故无下载链接.

OfflineShortVideo 支持使用 OfflineShortVideo.Builder 可通过上述七个必要参数和两个非必要参数构造 OfflineShortVideo 实例.

序列化支持

OfflineShortVideo 支持序列化. 可使用 MessageChain.serializeToJsonString 以及 MessageChain.deserializeFromJsonString. 也可以在 MessageSerializers.serializersModule 获取到 OfflineShortVideo 的 KSerializer.

要获取更多有关序列化的信息, 参阅 MessageSerializers.

Since

2.16

Types

Builder

class Builder

Key

object Key : AbstractPolymorphicMessageKey<ShortVideo, OfflineShortVideo>

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

abstract 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 发送给指定联系人

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

toString

abstract override fun toString(): String

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

Properties

content

val Message.content: String

Message.contentToString 的捷径

fileFormat

abstract val fileFormat: String

视频文件类型（拓展名）

fileMd5

abstract val fileMd5: ByteArray

视频文件 MD5. 16 bytes.

filename

abstract val filename: String

视频文件名, 不包括拓展名

fileSize

abstract val fileSize: Long

视频大小

key

open override val key: MessageKey<*>

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

videoId

abstract val videoId: String

视频 ID.