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

Image

@NotStableForInheritance

interface Image : Message, MessageContent, CodableMessage

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

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

根据 ID 构造图片

Image.fromId. 在 Kotlin, 更推荐使用顶层函数 val image = Image("id")

上传和发送图片

Contact.uploadImage 上传资源文件并得到 Image 消息
Contact.sendImage 上传资源文件并发送返回的 Image 作为一条消息
ExternalResource.uploadAsImage
ExternalResource.sendAsImageTo
Contact.sendImage

下载图片

Image.queryUrl 扩展函数. 查询图片下载链接
IMirai.queryImageUrl 查询图片下载链接 (Java 使用)

mirai 码支持

格式: [mirai:image:Image.imageId]

Types

AsStringSerializer

object AsStringSerializer : KSerializer<Image>

Builder

class Builder

Image 构建器.

FallbackSerializer

@MiraiInternalApi

open class FallbackSerializer(serialName: String) : KSerializer<Image>

Key

object Key : AbstractMessageKey<Image>

Serializer

object Serializer : KSerializer<Image>

Functions

appendMiraiCodeTo

@MiraiExperimentalApi

abstract 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 相等. strict 为 true 时, 还会额外判断每个消息元素的类型, 顺序和属性. 如 Image 会判断 Image.imageId

contentToString

abstract fun contentToString(): String

转为最接近官方格式的字符串. 如 At(member) + "test" 将转为 "@群名片 test".

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

plus

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

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

open operator fun plus(another: CharSequence): MessageChain

将 another 作为 PlainText 连接到这个消息的尾部.

open operator fun plus(another: String): MessageChain

将 another 作为 PlainText 连接到这个消息的尾部.

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

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

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

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

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

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

open operator fun plus(another: Message): MessageChain

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

open operator fun plus(another: MessageChain): MessageChain

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

open operator fun plus(another: SingleMessage): MessageChain

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

serializeToMiraiCode

open fun serializeToMiraiCode(): String

转换为 mirai 码.

toString

abstract override fun toString(): String

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

Properties

height

abstract val height: Int

图片的高度 (px), 当无法获取时为 0

imageId

abstract val imageId: String

图片的 id.

imageType

abstract val imageType: ImageType

图片的类型, 当无法获取时为未知 ImageType.UNKNOWN

isEmoji

open val isEmoji: Boolean

判断该图片是否为 动画表情

md5

open val md5: ByteArray

图片文件 MD5. 可用于 isUploaded.

size

abstract val size: Long

图片的大小（字节）, 当无法获取时为 0. 可用于 isUploaded.

width

abstract val width: Int

图片的宽度 (px), 当无法获取时为 0

Extensions

flash

inline fun Image.flash(): FlashImage

将普通图片转换为闪照.

isUploaded

suspend fun Image.isUploaded(bot: Bot): Boolean

当图片在服务器上存在时返回 true, 这意味着图片可以直接发送给 contact.

md5

@MiraiInternalApi

~~val~~ Image.~~md5~~: ByteArray

queryUrl

suspend fun Image.queryUrl(): String

查询原图下载链接.

Image

根据 ID 构造图片

上传和发送图片

下载图片

mirai 码支持

See also

Types

Functions

Properties

Extensions