Hunter.Announcement (hunter v0.7.0)

Copy Markdown View Source

Announcement entity

An announcement set by an administrator

Fields

  • id - the ID of the announcement
  • content - the text of the announcement, as HTML
  • starts_at - when the announcement starts being active, if time-limited
  • ends_at - when the announcement stops being active, if time-limited
  • all_day - whether the announcement should start and end on dates only instead of datetimes
  • published_at - when the announcement was published
  • updated_at - when the announcement was last updated
  • read - whether the announcement has been read by the authenticated user (only with user token)
  • mentions - accounts mentioned in the announcement text, list of maps with id, username, url and acct keys
  • statuses - statuses linked in the announcement text, list of maps with id and url keys
  • tags - list of Hunter.Tag used in the announcement text
  • emojis - list of Hunter.Emoji, custom emoji used in the announcement text
  • reactions - list of Hunter.Announcement.Reaction, emoji reactions attached to the announcement

Summary

Types

t()

Types

t()

@type t() :: %Hunter.Announcement{
  all_day: boolean(),
  content: String.t(),
  emojis: [Hunter.Emoji.t()],
  ends_at: String.t() | nil,
  id: String.t(),
  mentions: [map()],
  published_at: String.t(),
  reactions: [Hunter.Announcement.Reaction.t()],
  read: boolean() | nil,
  starts_at: String.t() | nil,
  statuses: [map()],
  tags: [Hunter.Tag.t()],
  updated_at: String.t()
}