mirai-core-api/net.mamoe.mirai.utils/ExternalResource/Companion

Companion

expect object Companion

actual object Companion

Functions

@JvmName(name = "sendAsFile")

~~suspend~~ ~~fun~~ <C : FileSupported> ExternalResource.~~sendAsFileTo~~( contact: C, path: String, callback: RemoteFile.ProgressionCallback? = null): MessageReceipt<C>

上传文件并发送件消息. 如果要上传的文件格式是图片或者语音, 也会将它们作为文件上传而不会调整消息类型.

sendAsImageTo

@JvmStatic

@JvmName(name = "sendAsImage")

expect suspend fun <C : Contact> ExternalResource.sendAsImageTo(contact: C): MessageReceipt<C>

将图片作为单独的消息发送给指定联系人.

@JvmStatic

@JvmName(name = "sendAsImage")

actual suspend fun <C : Contact> ExternalResource.sendAsImageTo(contact: C): MessageReceipt<C>

将图片作为单独的消息发送给指定联系人.

@JvmStatic

@JvmName(name = "sendAsImage")

@JvmOverloads

suspend fun <C : Contact> File.sendAsImageTo(contact: C, formatName: String? = null): MessageReceipt<C>

将文件作为图片发送到指定联系人.

@JvmStatic

@JvmName(name = "sendAsImage")

@JvmOverloads

suspend fun <C : Contact> InputStream.sendAsImageTo(contact: C, formatName: String? = null): MessageReceipt<C>

读取 InputStream 到临时文件并将其作为图片发送到指定联系人.

actual suspend fun <C : Contact> ExternalResource.sendAsImageTo(contact: C): MessageReceipt<C>

将图片作为单独的消息发送给指定联系人.

sendTo

@JvmStatic

@JvmOverloads

~~suspend~~ ~~fun~~ <C : FileSupported> File.~~sendTo~~( contact: C, path: String, callback: RemoteFile.ProgressionCallback? = null): MessageReceipt<C>

上传文件并发送文件消息.

toExternalResource

@JvmStatic

@JvmOverloads

@JvmName(name = "create")

expect fun ByteArray.toExternalResource(formatName: String? = null): ExternalResource

创建 ExternalResource. 注意, 返回的 ExternalResource 需要在使用完毕后调用 ExternalResource.close 关闭.

@JvmStatic

@JvmOverloads

@JvmName(name = "create")

fun File.toExternalResource(formatName: String? = null): ExternalResource

打开文件并创建 ExternalResource. 注意, 返回的 ExternalResource 需要在使用完毕后调用 ExternalResource.close 关闭.

@JvmStatic

@JvmOverloads

@JvmName(name = "create")

fun InputStream.toExternalResource(formatName: String? = null): ExternalResource

立即使用 FileCacheStrategy 缓存 InputStream 并创建 ExternalResource. 返回的 ExternalResource 需要在使用完毕后调用 ExternalResource.close 关闭.

@JvmStatic

@JvmOverloads

@JvmName(name = "create")

actual fun ByteArray.toExternalResource(formatName: String?): ExternalResource

创建 ExternalResource. 注意, 返回的 ExternalResource 需要在使用完毕后调用 ExternalResource.close 关闭.

@JvmStatic

@JvmOverloads

@JvmName(name = "create")

fun RandomAccessFile.toExternalResource(formatName: String? = null, closeOriginalFileOnClose: Boolean = true): ExternalResource

创建 ExternalResource. 注意, 返回的 ExternalResource 需要在使用完毕后调用 ExternalResource.close 关闭, 届时将会关闭 RandomAccessFile.

actual fun ByteArray.toExternalResource(formatName: String?): ExternalResource

创建 ExternalResource. 注意, 返回的 ExternalResource 需要在使用完毕后调用 ExternalResource.close 关闭.

uploadAsImage

@JvmStatic

expect suspend fun ExternalResource.uploadAsImage(contact: Contact): Image

上传图片并构造 Image. 这个函数可能需消耗一段时间.

@JvmStatic

actual suspend fun ExternalResource.uploadAsImage(contact: Contact): Image

上传图片并构造 Image. 这个函数可能需消耗一段时间.

@JvmStatic

@JvmOverloads

suspend fun File.uploadAsImage(contact: Contact, formatName: String? = null): Image

将文件作为图片上传后构造 Image.

@JvmStatic

@JvmOverloads

suspend fun InputStream.uploadAsImage(contact: Contact, formatName: String? = null): Image

读取 InputStream 到临时文件并将其作为图片上传后构造 Image.

actual suspend fun ExternalResource.uploadAsImage(contact: Contact): Image

上传图片并构造 Image. 这个函数可能需消耗一段时间.

Properties

DEFAULT_FORMAT_NAME

expect const val DEFAULT_FORMAT_NAME: String

在无法识别文件格式时使用的默认格式名. "mirai".

actual const val DEFAULT_FORMAT_NAME: String

在无法识别文件格式时使用的默认格式名. "mirai".

actual const val DEFAULT_FORMAT_NAME: String

在无法识别文件格式时使用的默认格式名. "mirai".