mirai-core-api/net.mamoe.mirai.contact.announcement/Announcements

Announcements

@NotStableForInheritance

interface Announcements : Streamable<OnlineAnnouncement>

表示一个群的公告列表 (管理器).

获取群公告

获取 Announcements 实例

只可以通过 Group.announcements 获取一个群的公告列表, 即 Announcements 实例.

获取公告列表

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

若要获取全部公告列表, 可使用 toList.

发布群公告

查看 Announcement

Since

2.7

Functions

expect abstract fun asFlow(): Flow<OnlineAnnouncement>

创建一个能获取 T 的 Flow.

abstract suspend fun delete(fid: String): Boolean

删除一条群公告. 需要管理员权限. 使用 OnlineAnnouncement.delete 与此方法效果相同.

abstract suspend fun get(fid: String): OnlineAnnouncement?

获取一条群公告.

abstract suspend fun publish(announcement: Announcement): OnlineAnnouncement

在该群发布群公告并获得 OnlineAnnouncement, 需要管理员权限. 发布公告后群内将会出现 "有新公告" 系统提示.

expect open suspend fun toList(): List<OnlineAnnouncement>

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

abstract suspend fun uploadImage(resource: ExternalResource): AnnouncementImage

上传资源作为群公告图片. 返回值可用于 AnnouncementParameters.image.