mirai-core-api/net.mamoe.mirai.contact.essence/Essences

Essences

@NotStableForInheritance

interface Essences : Streamable<EssenceMessageRecord>

表示一个群精华消息管理.

获取 Essences 实例

只可以通过 Group.essences 获取一个群的精华消息管理, 即 Essences 实例.

获取精华消息列表

通过 asFlow 或 asStream 可以获取到惰性流, 在从流中收集数据时才会请求服务器获取数据. 通常建议在 Kotlin 使用协程的 asFlow, 在 Java 使用 asStream.

若要获取全部精华消息列表, 可使用 toList.

获取精华消息分享链接

通过 share 可以获得一个精华消息的分享链接

移除精华消息

通过 remove 可以从列表中移除指定精华消息 (WEB API)

Since

2.15

Functions

abstract fun asFlow(): Flow<EssenceMessageRecord>

创建一个能获取 T 的 Flow.

open fun asStream(): <Error class: unknown class><T>

创建一个能获取该群内所有 T 的 Stream.

abstract suspend fun getPage(start: Int, limit: Int): List<EssenceMessageRecord>

按页获取精华消息记录

abstract suspend fun remove(source: MessageSource)

移除精华消息

abstract suspend fun share(source: MessageSource): String

分享精华消息

open suspend fun toList(): List<EssenceMessageRecord>

获取所有 T 列表, 将全部 T 都加载后再返回.