Struct botapi::gen_types::ReplyKeyboardMarkup

pub struct ReplyKeyboardMarkup {
    pub keyboard: Vec<Vec<KeyboardButton>>,
    pub is_persistent: Option<bool>,
    pub resize_keyboard: Option<bool>,
    pub one_time_keyboard: Option<bool>,
    pub input_field_placeholder: Option<String>,
    pub selective: Option<bool>,
}

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.

Fields

keyboard: Vec<Vec<KeyboardButton>>

Array of button rows, each represented by an Array of KeyboardButton objects

is_persistent: Option<bool>

Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.

resize_keyboard: Option<bool>

Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app’s standard keyboard.

one_time_keyboard: Option<bool>

Optional. Requests clients to hide the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.

input_field_placeholder: Option<String>

Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters

selective: Option<bool>

Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot’s message is a reply to a message in the same chat and forum topic, sender of the original message. Example: A user requests to change the bot’s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.

Implementations

impl ReplyKeyboardMarkup

pub fn noskip(self) -> NoSkipReplyKeyboardMarkup

impl ReplyKeyboardMarkup

pub fn new(keyboard: Vec<Vec<KeyboardButton>>) -> Self

pub fn get_keyboard<'a>(&'a self) -> &'a Vec<Vec<KeyboardButton>>

Array of button rows, each represented by an Array of KeyboardButton objects

pub fn set_keyboard<'a>( &'a mut self, keyboard: Vec<Vec<KeyboardButton>>, ) -> &'a mut Self

Array of button rows, each represented by an Array of KeyboardButton objects

pub fn get_is_persistent<'a>(&'a self) -> Option<bool>

Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.

pub fn set_is_persistent<'a>( &'a mut self, is_persistent: Option<bool>, ) -> &'a mut Self

Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.

pub fn get_resize_keyboard<'a>(&'a self) -> Option<bool>

Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app’s standard keyboard.

pub fn set_resize_keyboard<'a>( &'a mut self, resize_keyboard: Option<bool>, ) -> &'a mut Self

Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app’s standard keyboard.

pub fn get_one_time_keyboard<'a>(&'a self) -> Option<bool>

Optional. Requests clients to hide the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.

pub fn set_one_time_keyboard<'a>( &'a mut self, one_time_keyboard: Option<bool>, ) -> &'a mut Self

Optional. Requests clients to hide the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.

pub fn get_input_field_placeholder<'a>(&'a self) -> Option<&'a str>

Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters

pub fn set_input_field_placeholder<'a>( &'a mut self, input_field_placeholder: Option<String>, ) -> &'a mut Self

Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters

pub fn get_selective<'a>(&'a self) -> Option<bool>

Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot’s message is a reply to a message in the same chat and forum topic, sender of the original message. Example: A user requests to change the bot’s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.

pub fn set_selective<'a>(&'a mut self, selective: Option<bool>) -> &'a mut Self

Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot’s message is a reply to a message in the same chat and forum topic, sender of the original message. Example: A user requests to change the bot’s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.

Trait Implementations

impl Clone for ReplyKeyboardMarkup

fn clone(&self) -> ReplyKeyboardMarkup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReplyKeyboardMarkup

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

Formats the value using the given formatter.

impl Default for ReplyKeyboardMarkup

fn default() -> ReplyKeyboardMarkup

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReplyKeyboardMarkup

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BoxWrapper<Box<ReplyKeyboardMarkup>>> for ReplyKeyboardMarkup

fn from(t: BoxWrapper<Box<ReplyKeyboardMarkup>>) -> Self

Converts to this type from the input type.

impl From<BoxWrapper<Unbox<ReplyKeyboardMarkup>>> for ReplyKeyboardMarkup

fn from(t: BoxWrapper<Unbox<ReplyKeyboardMarkup>>) -> Self

Converts to this type from the input type.

impl From<NoSkipReplyKeyboardMarkup> for ReplyKeyboardMarkup

fn from(t: NoSkipReplyKeyboardMarkup) -> Self

Converts to this type from the input type.

impl Hash for ReplyKeyboardMarkup

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 Into<NoSkipReplyKeyboardMarkup> for ReplyKeyboardMarkup

fn into(self) -> NoSkipReplyKeyboardMarkup

Converts this type into the (usually inferred) input type.

impl Ord for ReplyKeyboardMarkup

fn cmp(&self, other: &ReplyKeyboardMarkup) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ReplyKeyboardMarkup

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ReplyKeyboardMarkup

fn partial_cmp(&self, other: &ReplyKeyboardMarkup) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ReplyKeyboardMarkup

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 ReplyKeyboardMarkup

impl StructuralPartialEq for ReplyKeyboardMarkup