|
| std::variant< std::int64_t, std::string > | chatId { } |
| | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Polls can't be sent to channel direct messages chats.
|
| std::string | question { } |
| | Poll question, 1-300 characters.
|
| std::vector< std::shared_ptr< InputPollOption > > | options { } |
| | A JSON-serialized list of 1-12 answer options.
|
| bool | disableNotification = false |
| | Sends the message silently. Users will receive a notification with no sound.
|
| std::shared_ptr< ReplyParameters > | replyParameters = nullptr |
| | Description of the message to reply to.
|
| std::variant< std::shared_ptr< InlineKeyboardMarkup >, std::shared_ptr< ReplyKeyboardMarkup >, std::shared_ptr< ReplyKeyboardRemove >, std::shared_ptr< ForceReply > > | 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.
|
| bool | isAnonymous = true |
| | True, if the poll needs to be anonymous, defaults to True.
|
| std::string | type = "" |
| | Poll type, “quiz” or “regular”, defaults to “regular”
|
| bool | allowsMultipleAnswers = false |
| | Pass True if the poll allows multiple answers, defaults to False.
|
| std::string | 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.
|
| std::string | explanationParseMode = "" |
| | Mode for parsing entities in the explanation. See formatting options for more details.
|
| std::vector< std::shared_ptr< MessageEntity > > | explanationEntities = { } |
| | A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode.
|
| std::int32_t | openPeriod = 0 |
| | Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with close_date.
|
| std::int32_t | closeDate = 0 |
| | Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with open_period.
|
| bool | isClosed = false |
| | Pass True if the poll needs to be immediately closed. This can be useful for poll preview.
|
| std::int32_t | messageThreadId = 0 |
| | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.
|
| bool | protectContent = false |
| | Protects the contents of the sent message from forwarding and saving.
|
| std::string | businessConnectionId = "" |
| | Unique identifier of the business connection on behalf of which the message will be sent.
|
| bool | allowAddingOptions = false |
| | Pass True if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes.
|
| bool | allowPaidBroadcast = false |
| | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
|
| bool | allowsRevoting = false |
| | Pass True if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls.
|
| std::vector< std::int32_t > | correctOptionIds = { } |
| | A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode.
|
| std::vector< std::string > | countryCodes = { } |
| | A JSON-serialized list of 0-12 two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll; for channel chats only. Use “FT” as a country code to allow users with anonymous numbers to vote. If omitted or empty, then users from any country can participate in the poll.
|
| std::string | description = "" |
| | Description of the poll to be sent, 0-1024 characters after entities parsing.
|
| std::vector< std::shared_ptr< MessageEntity > > | descriptionEntities = { } |
| | A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode.
|
| std::string | descriptionParseMode = "" |
| | Mode for parsing entities in the poll description. See formatting options for more details.
|
| std::shared_ptr< InputPollMedia > | explanationMedia = nullptr |
| | Media added to the quiz explanation.
|
| bool | hideResultsUntilCloses = false |
| | Pass True if poll results must be shown only after the poll closes.
|
| std::shared_ptr< InputPollMedia > | media = nullptr |
| | Media added to the poll description.
|
| bool | membersOnly = false |
| | Pass True if voting is limited to users who have been members of the chat where the poll is being sent for more than 24 hours; for channel chats only.
|
| std::string | messageEffectId = "" |
| | Unique identifier of the message effect to be added to the message; for private chats only.
|
| std::vector< std::shared_ptr< MessageEntity > > | questionEntities = { } |
| | A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode.
|
| std::string | questionParseMode = "" |
| | Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed.
|
| bool | shuffleOptions = false |
| | Pass True if the poll options must be shown in random order.
|
Arguments for Api::sendPoll.
Definition at line 19271 of file Types.h.
1.18.0