SendPoll

Struct SendPoll 

Source
pub struct SendPoll {
Show 18 fields 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>, pub protect_content: Option<bool>,
}
Expand description

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.

§protect_content: Option<bool>

Protects the contents of the sent message from forwarding and saving

Implementations§

Source§

impl SendPoll

Source

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

Source

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

Source

pub fn anonymous(self) -> Self

Set the poll as anonymous

Source

pub fn allow_multiple_answers(self) -> Self

Allow multiple answers

Source

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

Set explanation

Source

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

Set explanation parse mode

Source

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

Set explanation entities

Source

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

Add explanation entity

Source

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

Set open period. This sets close_date to None

Source

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

Set close date. This sets open_period to None

Source

pub fn closed(self) -> Self

Set the poll as closed

Source

pub fn disable_notification(self) -> Self

Disable notification

Source

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

Reply to message

Source

pub fn allow_sending_without_reply(self) -> Self

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

Source

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

Set reply markup

Source

pub fn protect_content(self) -> Self

Protect content

Trait Implementations§

Source§

impl Clone for SendPoll

Source§

fn clone(&self) -> SendPoll

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Serialize for SendPoll

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TelegramMethod for SendPoll

Source§

type Response = Message

Source§

fn name() -> &'static str

Source§

impl JsonMethod for SendPoll

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.