Struct telbot_types::message::SendPoll

pub struct SendPoll {

    pub chat_id: ChatId,
    pub question: String,
    pub options: Vec<String>,
    pub is_anonymous: Option<bool>,
    pub kind: Option<String>,
    pub allows_multiple_answers: Option<bool>,
    pub correct_option_id: Option<u32>,
    pub explanation: Option<String>,
    pub explanation_parse_mode: Option<ParseMode>,
    pub explanation_entities: Option<Vec<MessageEntity>>,
    pub open_period: Option<u32>,
    pub close_date: Option<u64>,
    pub is_closed: Option<bool>,
    pub disable_notification: Option<bool>,
    pub reply_to_message_id: Option<i64>,
    pub allow_sending_without_reply: Option<bool>,
    pub reply_markup: Option<ReplyMarkup>,
}

Use this method to send a native poll. On success, the sent Message is returned.

Fields

chat_id: ChatId

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

question: String

Poll question, 1-300 characters

options: Vec<String>

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

is_anonymous: Option<bool>

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

kind: Option<String>

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

allows_multiple_answers: Option<bool>

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

correct_option_id: Option<u32>

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

explanation: Option<String>

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

explanation_parse_mode: Option<ParseMode>

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

explanation_entities: Option<Vec<MessageEntity>>

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

open_period: Option<u32>

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

close_date: Option<u64>

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.

is_closed: Option<bool>

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

disable_notification: Option<bool>

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

reply_to_message_id: Option<i64>

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

allow_sending_without_reply: Option<bool>

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

reply_markup: Option<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.

Implementations

impl SendPoll

pub fn new_regular(
    chat_id: impl Into<ChatId>,
    question: impl Into<String>,
    options: Vec<String>
) -> Self

Create a new sendPoll request to send a regular poll

pub fn new_quiz(
    chat_id: impl Into<ChatId>,
    question: impl Into<String>,
    options: Vec<String>,
    correct_option_id: u32
) -> Self

Create a new sendPoll request to send a quiz

pub fn anonymous(self) -> Self

Set the poll as anonymous

pub fn allow_multiple_answers(self) -> Self

Allow multiple answers

pub fn with_explanation(self, explanation: impl Into<String>) -> Self

Set explanation

pub fn with_parse_mode(self, parse_mode: ParseMode) -> Self

Set explanation parse mode

pub fn with_entities(self, entities: Vec<MessageEntity>) -> Self

Set explanation entities

pub fn with_entity(self, entity: MessageEntity) -> Self

Add explanation entity

pub fn with_open_period(self, period: u32) -> Self

Set open period. This sets close_date to None

pub fn with_close_date(self, close_date: u64) -> Self

Set close date. This sets open_period to None

pub fn closed(self) -> Self

Set the poll as closed

pub fn disable_notification(self) -> Self

Disable notification

pub fn reply_to(self, message_id: i64) -> Self

Reply to message

pub fn allow_sending_without_reply(self) -> Self

Allow sending message even if the replying message isn’t present

pub fn with_reply_markup(self, markup: impl Into<ReplyMarkup>) -> Self

Set reply markup

Trait Implementations

impl Serialize for SendPoll

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TelegramMethod for SendPoll

type Response = Message

fn name() -> &'static str

impl JsonMethod for SendPoll