Struct tg_botapi::api::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).

Fields

keyboard: Vec<Vec<KeyboardButton>>

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

is_persistent: Option<bool>

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>

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>

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>

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

selective: Option<bool>

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 (has reply_to_message_id), 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 new(keyboard: Vec<Vec<KeyboardButton>>) -> Self

impl ReplyKeyboardMarkup

pub fn with_is_persistent(self, is_persistent: bool) -> Self

pub fn with_resize_keyboard(self, resize_keyboard: bool) -> Self

pub fn with_one_time_keyboard(self, one_time_keyboard: bool) -> Self

pub fn with_input_field_placeholder(
self,
input_field_placeholder: String
) -> Self

pub fn with_selective(self, selective: bool) -> Self

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<'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<ReplyKeyboardMarkup> for ReplyMarkup

fn from(o: ReplyKeyboardMarkup) -> Self

Converts to this type from the input type.

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.