Poll

data class Poll(id: String, question: String, options: List<PollOption>, totalVoterCount: Int, isClosed: Boolean, isAnonymous: Boolean, allowsMultipleAnswers: Boolean, correctOptionId: Int?, explanation: String?, explanationEntities: List<MessageEntity>, openPeriod: Int?, closeDate: Int?, type: String)

This object contains information about a poll.

Parameters

Unique poll identifier

question

Poll question, 1-300 characters

options

List of poll options

totalVoterCount

Total number of users that voted in the poll

isClosed

True, if the poll is closed

isAnonymous

True, if the poll is anonymous

allowsMultipleAnswers

True, if the poll allows multiple answers

correctOptionId

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

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

explanationEntities

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

openPeriod

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

closeDate

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

type

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

Constructors

Poll

common

fun Poll(id: String, question: String, options: List<PollOption> = emptyList(), totalVoterCount: Int, isClosed: Boolean, isAnonymous: Boolean, allowsMultipleAnswers: Boolean, correctOptionId: Int? = null, explanation: String? = null, explanationEntities: List<MessageEntity> = emptyList(), openPeriod: Int? = null, closeDate: Int? = null, type: String)

Unique poll identifier

Functions

component1

common

operator fun component1(): String

component10

common

operator fun component10(): List<MessageEntity>

component11

common

operator fun component11(): Int?

component12

common

operator fun component12(): Int?

component13

common

operator fun component13(): String

component2

common

operator fun component2(): String

component3

common

operator fun component3(): List<PollOption>

component4

common

operator fun component4(): Int

component5

common

operator fun component5(): Boolean

component6

common

operator fun component6(): Boolean

component7

common

operator fun component7(): Boolean

component8

common

operator fun component8(): Int?

component9

common

operator fun component9(): String?

copy

common

fun copy(id: String, question: String, options: List<PollOption> = emptyList(), totalVoterCount: Int, isClosed: Boolean, isAnonymous: Boolean, allowsMultipleAnswers: Boolean, correctOptionId: Int? = null, explanation: String? = null, explanationEntities: List<MessageEntity> = emptyList(), openPeriod: Int? = null, closeDate: Int? = null, type: String): Poll

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

toString

common

open override fun toString(): String