Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPoll

This object contains information about a poll.

Hierarchy

  • IPoll

Index

Properties

allows_multiple_answers: boolean

True, if the poll allows multiple answers

close_data: number

Optional. Point in time (Unix timestamp) when the poll will be automatically closed

correct_option_id?: number

Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.

explanation?: string

Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters

explanation_entities?: IMessageEntity[]

Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation

id: string

Unique poll identifier

is_anonymous: boolean

True, if the poll is anonymous

is_closed: boolean

True, if the poll is closed

open_period?: number

Optional. Amount of time in seconds the poll will be active after creation

options: IPollOption[]

List of poll options

question: string

Poll question, 1-300 characters

total_voter_count: number

Total number of users that voted in the poll

type: string

Poll type, currently can be “regular” or “quiz”

Generated using TypeDoc