mastodonk-core/fr.outadoc.mastodonk.api.entity/Announcement

Announcement

@Serializable
data class Announcement(val announcementId: String, val text: String, val isPublished: Boolean, val isAllDay: Boolean, val createdAt: Instant, val updatedAt: Instant, val isRead: Boolean, val reactions: List<AnnouncementReaction>, val scheduledAt: Instant? = null, val startsAt: Instant? = null, val endsAt: Instant? = null)

Represents an announcement set by an administrator.

Constructors

Link copied to clipboard
constructor(announcementId: String, text: String, isPublished: Boolean, isAllDay: Boolean, createdAt: Instant, updatedAt: Instant, isRead: Boolean, reactions: List<AnnouncementReaction>, scheduledAt: Instant? = null, startsAt: Instant? = null, endsAt: Instant? = null)

Properties

Link copied to clipboard
Link copied to clipboard
val createdAt: Instant

Moment at which the announcement was created.

Link copied to clipboard
val endsAt: Instant? = null

Time at which the announcement will end.

Link copied to clipboard
val isAllDay: Boolean

Whether the announcement has a start/end time.

Link copied to clipboard
val isPublished: Boolean

Whether the announcement is currently active.

Link copied to clipboard
val isRead: Boolean

Whether the announcement has been read by the user.

Link copied to clipboard
val reactions: List<AnnouncementReaction>

Emoji reactions attached to the announcement.

Link copied to clipboard
val scheduledAt: Instant? = null

Time at which a scheduled announcement was scheduled.

Link copied to clipboard
val startsAt: Instant? = null

Time at which the announcement will start.

Link copied to clipboard
val text: String

The content of the announcement.

Link copied to clipboard
val updatedAt: Instant

Moment at which the announcement was last updated.