class

Tourmaline::Poll

Inherits JSON::Serializable / Reference / Object

This object contains information about a poll.

Constructors

new(id : String, question : String, total_voter_count : Int32 | Int64, is_closed : Bool, is_anonymous : Bool, type : String, allows_multiple_answers : Bool, options : Array(Tourmaline::PollOption) = [] of Tourmaline::PollOption, correct_option_id : Int32 | Int64 | Nil = nil, explanation : String | Nil = nil, explanation_entities : Array(Tourmaline::MessageEntity) = [] of Tourmaline::MessageEntity, open_period : Int32 | Int64 | Nil = nil, close_date : Int32 | Int64 | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

allows_multiple_answers=(allows_multiple_answers : Bool)

True, if the poll allows multiple answers

Source
allows_multiple_answers?

True, if the poll allows multiple answers

Source
close_date

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

Source
close_date=(close_date : Time | Nil)

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

Source
correct_option_id

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.

Source
correct_option_id=(correct_option_id : Int32 | Int64 | Nil)

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.

Source
explanation

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

Source
explanation=(explanation : String | Nil)

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

Source
explanation_entities

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

Source
explanation_entities=(explanation_entities : Array(Tourmaline::MessageEntity))

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

Source
id

Unique poll identifier

Source
id=(id : String)

Unique poll identifier

Source
is_anonymous=(is_anonymous : Bool)

True, if the poll is anonymous

Source
is_anonymous?

True, if the poll is anonymous

Source
is_closed=(is_closed : Bool)

True, if the poll is closed

Source
is_closed?

True, if the poll is closed

Source
open_period

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

Source
open_period=(open_period : Int32 | Int64 | Nil)

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

Source
options

List of poll options

Source
options=(options : Array(Tourmaline::PollOption))

List of poll options

Source
question

Poll question, 1-300 characters

Source
question=(question : String)

Poll question, 1-300 characters

Source
total_voter_count

Total number of users that voted in the poll

Source
total_voter_count=(total_voter_count : Int32 | Int64)

Total number of users that voted in the poll

Source
type

Poll type, currently can be "regular" or "quiz"

Source
type=(type : String)

Poll type, currently can be "regular" or "quiz"

Source