Class Poll

constructor

• new Poll(
      raw: RawPoll,
      _peers: PeersIndex,
      results?: RawPollResults,
      attachedMedia?: MessageMedia,
  ): Poll

  Parameters

  • raw: RawPoll
  • _peers: PeersIndex
  • Optionalresults: RawPollResults
  • OptionalattachedMedia: MessageMedia

  Returns Poll

Readonly_peers

Optional ReadonlyattachedMedia

Readonlyraw

Optional Readonlyresults

Readonlytype

answers

• get answers(): readonly PollAnswer[]

  List of answers in this poll

  Returns readonly PollAnswer[]

canAddAnswers

• get canAddAnswers(): boolean

  Whether new options can be suggested to this poll

  Returns boolean

hasUnreaVotes

• get hasUnreaVotes(): boolean

  Whether the poll has unread votes

  Returns boolean

hideResultsUntilClose

• get hideResultsUntilClose(): boolean

  Whether the results of this poll are hidden until the end of the poll

  Returns boolean

id

• get id(): Long

  Unique identifier of the poll

  Returns Long

inputMedia

• get inputMedia(): TypeInputMedia

  Input media TL object generated from this object, to be used inside InputMediaLike and TelegramClient.sendMedia

  A few notes:

  • Using this will result in an independent poll, which will not be auto-updated with the current.
  • If this is a quiz, a normal poll will be returned since the client does not know the correct answer.
  • This always returns a non-closed poll, even if the current poll was closed

  Returns TypeInputMedia

isClosed

• get isClosed(): boolean

  Whether this poll is closed, i.e. does not accept votes anymore

  Returns boolean

isCreator

• get isCreator(): boolean

  Whether the current user is the creator of this poll

  Returns boolean

isMultiple

• get isMultiple(): boolean

  Whether this poll accepts multiple answers

  Returns boolean

isPublic

• get isPublic(): boolean

  Whether this poll is public, i.e. you list of voters is publicly available

  Returns boolean

isQuiz

• get isQuiz(): boolean

  Whether this is a quiz

  Returns boolean

isRevotingDisabled

• get isRevotingDisabled(): boolean

  Whether retracting the vote is disabled in this poll

  Returns boolean

question

• get question(): string

  Poll question

  Returns string

questionEntities

• get questionEntities(): readonly MessageEntity[]

  Format entities for question (currently may only contain custom emojis)

  Returns readonly MessageEntity[]

shuffleAnswers

• get shuffleAnswers(): boolean

  Whether answers to this poll should be shuffled before showing to the user

  Returns boolean

solution

• get solution(): string | null

  Solution for the quiz, only available in case you have already answered

  Returns string | null

solutionEntities

• get solutionEntities(): readonly MessageEntity[] | null

  Format entities for solution, only available in case you have already answered

  Returns readonly MessageEntity[] | null

solutionMedia

• get solutionMedia(): MessageMedia

  Media attached to the solution, if any

  Returns MessageMedia

voters

• get voters(): number

  Total number of voters in this poll, if available

  Returns number