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

Package net.mamoe.mirai.contact.announcement

Types

interface Announcement

表示一个 (群) 公告.

AnnouncementImage

class AnnouncementImage

群公告图片. 可通过 Announcements.uploadImage 上传获得. 不确定服务器会保存多久.

AnnouncementParameters

class AnnouncementParameters

群公告的附加参数.

AnnouncementParametersBuilder

class AnnouncementParametersBuilder @JvmOverloads constructor(prototype: AnnouncementParameters = AnnouncementParameters.DEFAULT)

AnnouncementParameters 的构建器. 可以构建一个 AnnouncementParameters 实例.

@NotStableForInheritance

interface Announcements : Streamable<OnlineAnnouncement>

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

OfflineAnnouncement

interface OfflineAnnouncement : Announcement

表示在本地构建的 Announcement.

OnlineAnnouncement

@NotStableForInheritance

interface OnlineAnnouncement : Announcement

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

Functions

buildAnnouncementParameters

inline fun buildAnnouncementParameters(builderAction: AnnouncementParametersBuilder.() -> Unit): AnnouncementParameters

使用 AnnouncementParametersBuilder 构建 AnnouncementParameters.

OfflineAnnouncement

inline fun OfflineAnnouncement(from: Announcement): OfflineAnnouncement

依据 from 创建 OfflineAnnouncement. 若 from 类型为 OfflineAnnouncement 则直接返回 from.

inline fun OfflineAnnouncement(content: String, parameters: AnnouncementParametersBuilder.() -> Unit): OfflineAnnouncement

inline fun OfflineAnnouncement(content: String, parameters: AnnouncementParameters = AnnouncementParameters.DEFAULT): OfflineAnnouncement

创建 AnnouncementParameters 并创建 OfflineAnnouncement.

inline fun Announcement.toOffline(): OfflineAnnouncement

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

Properties

val OnlineAnnouncement.bot: Bot

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