SendPollRequest

data class SendPollRequest(chatId: Int, question: String, options: List<String>, isAnonymous: Boolean, type: String?, allowsMultipleAnswers: Boolean, correctOptionId: Int?, explanation: String?, explanationParseMode: String?, explanationEntities: List<MessageEntity>, openPeriod: Int?, closeDate: Int?, isClosed: Boolean, disableNotification: Boolean, replyToMessageId: Int?, allowSendingWithoutReply: Boolean, replyMarkup: ReplyMarkup?)

Request body for sendPoll

Parameters

chatId

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

question

Poll question, 1-300 characters

options

A JSON-serialized list of answer options, 2-10 strings 1-100 characters each

isAnonymous

True, if the poll needs to be anonymous, defaults to True

type

Poll type, “quiz” or “regular”, defaults to “regular”

allowsMultipleAnswers

True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False

correctOptionId

0-based identifier of the correct answer option, required for polls in quiz mode

explanation

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 with at most 2 line feeds after entities parsing

explanationParseMode

Mode for parsing entities in the explanation. See formatting options for more details.

explanationEntities

List of special entities that appear in the poll explanation, which can be specified instead of parse_mode

openPeriod

Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.

closeDate

Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.

isClosed

Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.

disableNotification

Sends the message silently. Users will receive a notification with no sound.

replyToMessageId

If the message is a reply, ID of the original message

allowSendingWithoutReply

Pass True, if the message should be sent even if the specified replied-to message is not found

replyMarkup

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Constructors

SendPollRequest

common

fun SendPollRequest(chatId: Int, question: String, options: List<String> = emptyList(), isAnonymous: Boolean = false, type: String? = null, allowsMultipleAnswers: Boolean = false, correctOptionId: Int? = null, explanation: String? = null, explanationParseMode: String? = null, explanationEntities: List<MessageEntity> = emptyList(), openPeriod: Int? = null, closeDate: Int? = null, isClosed: Boolean = false, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null)

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Functions

component1

common

operator fun component1(): Int

component10

common

operator fun component10(): List<MessageEntity>

component11

common

operator fun component11(): Int?

component12

common

operator fun component12(): Int?

component13

common

operator fun component13(): Boolean

component14

common

operator fun component14(): Boolean

component15

common

operator fun component15(): Int?

component16

common

operator fun component16(): Boolean

component17

common

operator fun component17(): ReplyMarkup?

component2

common

operator fun component2(): String

component3

common

operator fun component3(): List<String>

component4

common

operator fun component4(): Boolean

component5

common

operator fun component5(): String?

component6

common

operator fun component6(): Boolean

component7

common

operator fun component7(): Int?

component8

common

operator fun component8(): String?

component9

common

operator fun component9(): String?

copy

common

fun copy(chatId: Int, question: String, options: List<String> = emptyList(), isAnonymous: Boolean = false, type: String? = null, allowsMultipleAnswers: Boolean = false, correctOptionId: Int? = null, explanation: String? = null, explanationParseMode: String? = null, explanationEntities: List<MessageEntity> = emptyList(), openPeriod: Int? = null, closeDate: Int? = null, isClosed: Boolean = false, disableNotification: Boolean = false, replyToMessageId: Int? = null, allowSendingWithoutReply: Boolean = false, replyMarkup: ReplyMarkup? = null): SendPollRequest

equals

common

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

hashCode

common

open override fun hashCode(): Int

toString

common

open override fun toString(): String

Properties

allowSendingWithoutReply

common

val allowSendingWithoutReply: Boolean = false

Pass True, if the message should be sent even if the specified replied-to message is not found

allowsMultipleAnswers

common

val allowsMultipleAnswers: Boolean = false

True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False

chatId

common

val chatId: Int

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

closeDate

common

val closeDate: Int? = null

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

correctOptionId

common

val correctOptionId: Int? = null

0-based identifier of the correct answer option, required for polls in quiz mode

disableNotification

common

val disableNotification: Boolean = false

Sends the message silently.

explanation

common

val explanation: String? = null

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 with at most 2 line feeds after entities parsing

explanationEntities

common

val explanationEntities: List<MessageEntity>

List of special entities that appear in the poll explanation, which can be specified instead of parse_mode

explanationParseMode

common

val explanationParseMode: String? = null

Mode for parsing entities in the explanation.

isAnonymous

common

val isAnonymous: Boolean = false

True, if the poll needs to be anonymous, defaults to True