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

OnlineAnnouncement

@NotStableForInheritance
interface OnlineAnnouncement : Announcement

表示从 Announcements.get 等途径在线获取的, 已经存在于服务器的公告.

OnlineAnnouncement 拥有唯一识别属性 fid 代表其存在于服务器中的 ID. 可进行 删除

可在 Announcement 获取更多信息.

Since

2.7

Functions

Link copied to clipboard
open suspend fun delete(): Boolean

删除这个公告. 需要管理员权限. 使用 Announcements.delete 与此方法效果相同.

Link copied to clipboard
open suspend fun members(confirmed: Boolean): List<NormalMember>

获取 已确认/未确认 的群成员

Link copied to clipboard
open suspend fun publishTo(group: Group): OnlineAnnouncement

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

Link copied to clipboard
open suspend fun remind()

提醒 未确认 的群成员

Link copied to clipboard
inline fun Announcement.toOffline(): OfflineAnnouncement

创建 OfflineAnnouncement. 若 this 类型为 OfflineAnnouncement 则直接返回 this.

Properties

Link copied to clipboard
abstract val allConfirmed: Boolean

所有人都已阅读, 如果 AnnouncementParameters.requireConfirmation 为 true 则为所有人都已确认.

Link copied to clipboard
val OnlineAnnouncement.bot: Bot

公告所在群所属的 Bot, 即 group.bot.

Link copied to clipboard
abstract val confirmedMembersCount: Int

已经阅读的成员数量，如果 AnnouncementParameters.requireConfirmation 为 true 则为已经确认的成员数量

Link copied to clipboard
abstract val content: String

内容

Link copied to clipboard
abstract val fid: String

唯一识别属性

Link copied to clipboard
abstract val group: Group

公告所属群

Link copied to clipboard
abstract val parameters: AnnouncementParameters

附加参数. 可以通过 AnnouncementParametersBuilder 构建获得.

Link copied to clipboard
abstract val publicationTime: Long

公告发出的时间，为 EpochSecond (自 1970-01-01T00：00：00Z 的秒数)

Link copied to clipboard
abstract val sender: NormalMember?

公告发送者. 当该成员已经离开群后为 null

Link copied to clipboard
abstract val senderId: Long

公告发送者 NormalMember.id