Struct teloxide_core::payloads::SendPoll

pub struct SendPoll {

    pub chat_id: Recipient,
    pub question: String,
    pub options: Vec<String>,
    pub message_thread_id: Option<ThreadId>,
    pub is_anonymous: Option<bool>,
    pub type_: Option<PollType>,
    pub allows_multiple_answers: Option<bool>,
    pub correct_option_id: Option<u8>,
    pub explanation: Option<String>,
    pub explanation_parse_mode: Option<ParseMode>,
    pub explanation_entities: Option<Vec<MessageEntity>>,
    pub open_period: Option<u16>,
    pub close_date: Option<DateTime<Utc>>,
    pub is_closed: Option<bool>,
    pub disable_notification: Option<bool>,
    pub protect_content: Option<bool>,
    pub reply_parameters: Option<ReplyParameters>,
    pub reply_markup: Option<ReplyMarkup>,
}

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

Fields

chat_id: Recipient

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

message_thread_id: Option<ThreadId>

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

is_anonymous: Option<bool>

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

type_: Option<PollType>

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<u8>

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 message text. 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<u16>

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<DateTime<Utc>>

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.

protect_content: Option<bool>

Protects the contents of sent messages from forwarding and saving

reply_parameters: Option<ReplyParameters>

Description of the message to reply to

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( chat_id: impl Into<Recipient>, question: impl Into<String>, options: impl IntoIterator<Item = String>, ) -> Self

Trait Implementations

impl Clone for SendPoll

fn clone(&self) -> SendPoll

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SendPoll

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for SendPoll

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SendPoll

fn eq(&self, other: &SendPoll) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Payload for SendPoll

type Output = Message

The return type of a Telegram method.

const NAME: &'static str = "SendPoll"

Name of a Telegram method.

fn timeout_hint(&self) -> Option<Duration>

If this payload may take long time to execute (e.g. GetUpdates with big timeout), the minimum timeout that should be used.

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 Eq for SendPoll

impl StructuralPartialEq for SendPoll