mirai-core-api/net.mamoe.mirai.contact/FileSupported

FileSupported

@NotStableForInheritance
interface FileSupported : Contact

支持文件操作的 Contact. 目前仅 Group.

获取文件操作相关示例: RemoteFiles

Since

2.5

See also

Inheritors

Functions

Link copied to clipboard
@JvmName(name = "getAvatarUrl")
open fun avatarUrl(spec: AvatarSpec): String

头像下载链接.

Link copied to clipboard
fun CoroutineScope.globalEventChannel(coroutineContext: CoroutineContext = EmptyCoroutineContext): EventChannel<Event>

在此 CoroutineScope 下创建一个监听所有事件的 EventChannel. 相当于 GlobalEventChannel.parentScope(this).context(coroutineContext).

Link copied to clipboard
inline suspend fun Contact.recallMessage(source: MessageChain)
inline suspend fun Contact.recallMessage(source: MessageSource)
Link copied to clipboard
open suspend fun sendMessage(message: String): MessageReceipt<Contact>

发送纯文本消息

abstract suspend fun sendMessage(message: Message): MessageReceipt<Contact>

向这个对象发送消息.

Link copied to clipboard
@JvmStatic
suspend fun Contact.sendNudge(nudge: Nudge): Boolean

发送戳一戳消息.

Link copied to clipboard
abstract suspend fun uploadImage(resource: ExternalResource): Image

上传一个 资源 作为图片以备发送.

Link copied to clipboard
suspend fun Contact.uploadImage(resource: ExternalResource): Image
suspend fun Contact.uploadImage(file: <Error class: unknown class>, formatName: String? = null): Image

将文件作为图片上传, 但不发送

suspend fun Contact.uploadImage(imageStream: <Error class: unknown class>, formatName: String? = null): Image

读取 InputStream 到临时文件并将其作为图片上传, 但不发送

Link copied to clipboard
abstract suspend fun uploadShortVideo(thumbnail: ExternalResource, video: ExternalResource, fileName: String? = null): ShortVideo

上传 资源 作为短视频发送. 同时需要上传缩略图作为视频消息显示的封面.

Properties

Link copied to clipboard
open val avatarUrl: String

头像下载链接, 规格默认为 AvatarSpec.LARGEST

Link copied to clipboard
abstract override val bot: Bot

这个联系对象所属 Bot.

Link copied to clipboard
Link copied to clipboard
abstract val files: RemoteFiles

获取远程文件列表 (管理器).

Link copied to clipboard
abstract val filesRoot: RemoteFile

文件根目录. 可通过 net.mamoe.mirai.utils.RemoteFile.listFiles 获取目录下文件列表.

Link copied to clipboard
abstract override val id: Long

可以是 QQ 号码或者群号码.