mirai-core / net.mamoe.mirai.message.data / Image

Image

interface Image : Message, MessageContent

自定义表情 (收藏的表情) 和普通图片.

最推荐的存储方式是存储图片原文件, 每次发送图片时都使用文件上传. 在上传时服务器会根据其缓存情况回复已有的图片 ID 或要求客户端上传. 详见 Contact.uploadImage

toStringcontentToString

上传和发送图片

See Also

Contact.uploadImage

Contact.sendImage

Image.sendTo

FlashImage

Image.flash

Types

Key

companion object Key : Key<Image>

Properties

DoNotImplementThisClass

abstract val DoNotImplementThisClass: Nothing?

imageId

图片的 id.

abstract val imageId: String

Companion Object Properties

typeName

Key 指代的 Message 类型名. 一般为 class.simpleName, 如 "QuoteReply", "PlainText"

val typeName: String

Extension Properties

md5

val Image.md5: ByteArray

Extension Functions

flash

fun Image.flash(): FlashImage

flash2

fun Image.flash2(): FlashImage

flatten

扁平化 Message

fun Message.flatten(): Sequence<SingleMessage>

isContentEmpty

判断消息内容是否为空.

fun Message.isContentEmpty(): Boolean

isContentNotEmpty

fun Message.isContentNotEmpty(): Boolean

isNotPlain

fun Message.isNotPlain(): Boolean

isNotPlain2

fun Message.isNotPlain2(): Boolean

isPlain

fun Message.isPlain(): Boolean

isPlain2

fun Message.isPlain2(): Boolean

queryUrl

查询原图下载链接.

suspend fun Image.queryUrl(): String

repeat

fun Message.repeat(count: Int): MessageChain

repeat2

fun Message.repeat2(count: Int): MessageChain

sendTo

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

times

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

toForwardMessage

转换为 ForwardMessage

fun Message.toForwardMessage(sender: User, time: Int = currentTimeSeconds.toInt(), displayStrategy: DisplayStrategy = DisplayStrategy): ForwardMessage
fun Message.toForwardMessage(senderId: Long, senderName: String, time: Int = currentTimeSeconds.toInt(), displayStrategy: DisplayStrategy = DisplayStrategy): ForwardMessage

Inheritors

AbstractImage

所有 Image 实现的基类.

sealed class AbstractImage : Image

OfflineImage

离线的图片, 即为客户端主动上传到服务器而获得的 Image 实例. 不能直接获取它在服务器上的链接. 需要通过 Bot.queryImageUrl 查询

interface OfflineImage : Image

OnlineImage

在服务器上的图片. 它可以直接获取下载链接.

interface OnlineImage : Image