Hunter.Poll (hunter v0.7.0)

Copy Markdown View Source

Poll entity

A poll attached to a Hunter.Status

Fields

  • id - the ID of the poll
  • expires_at - when the poll ends, if it has an end
  • expired - whether the poll is currently expired
  • multiple - whether the poll allows multiple-choice answers
  • votes_count - how many votes have been received
  • voters_count - how many unique accounts have voted, nil when the poll is not multiple-choice
  • options - list of Hunter.Poll.Option, the possible answers
  • emojis - list of Hunter.Emoji, custom emoji used in the options
  • voted - whether the authenticated user has voted (only with user token)
  • own_votes - which options the authenticated user chose, by index (only with user token)

Summary

Types

t()

Types

t()

@type t() :: %Hunter.Poll{
  emojis: [Hunter.Emoji.t()],
  expired: boolean(),
  expires_at: String.t() | nil,
  id: String.t(),
  multiple: boolean(),
  options: [Hunter.Poll.Option.t()],
  own_votes: [non_neg_integer()] | nil,
  voted: boolean() | nil,
  voters_count: non_neg_integer() | nil,
  votes_count: non_neg_integer()
}