SendPollReq

telegramium.bots.client.SendPollReq
final case class SendPollReq(chatId: ChatId, question: String, businessConnectionId: Option[String], messageThreadId: Option[Int], options: List[String], isAnonymous: Option[Boolean], `type`: Option[String], allowsMultipleAnswers: Option[Boolean], correctOptionId: Option[Int], explanation: Option[String], explanationParseMode: Option[ParseMode], explanationEntities: List[MessageEntity], openPeriod: Option[Int], closeDate: Option[Int], isClosed: Option[Boolean], disableNotification: Option[Boolean], protectContent: Option[Boolean], replyParameters: Option[ReplyParameters], replyMarkup: Option[KeyboardMarkup])

Value parameters

allowsMultipleAnswers

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

businessConnectionId

Unique identifier of the business connection on behalf of which the message will be sent

chatId

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

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.

correctOptionId

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

disableNotification

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

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

explanationEntities

A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode

explanationParseMode

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

isAnonymous

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

isClosed

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

messageThreadId

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

openPeriod

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

options

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

protectContent

Protects the contents of the sent message from forwarding and saving

question

Poll question, 1-300 characters

replyMarkup

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account

replyParameters

Description of the message to reply to

type

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

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product