Struct botapi::gen_types::InlineKeyboardButtonBuilder

pub struct InlineKeyboardButtonBuilder {
    pub text: String,
    pub url: Option<String>,
    pub callback_data: Option<String>,
    pub web_app: Option<BoxWrapper<Unbox<WebAppInfo>>>,
    pub login_url: Option<BoxWrapper<Unbox<LoginUrl>>>,
    pub switch_inline_query: Option<String>,
    pub switch_inline_query_current_chat: Option<String>,
    pub switch_inline_query_chosen_chat: Option<BoxWrapper<Unbox<SwitchInlineQueryChosenChat>>>,
    pub callback_game: Option<BoxWrapper<Unbox<CallbackGame>>>,
    pub pay: Option<bool>,
}

This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.

Fields

text: String

Label text on the button

url: Option<String>

Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.

callback_data: Option<String>

Optional. Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes

web_app: Option<BoxWrapper<Unbox<WebAppInfo>>>

Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.

login_url: Option<BoxWrapper<Unbox<LoginUrl>>>

Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.

switch_inline_query: Option<String>

Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot’s username and the specified inline query in the input field. May be empty, in which case just the bot’s username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.

switch_inline_query_current_chat: Option<String>

Optional. If set, pressing the button will insert the bot’s username and the specified inline query in the current chat’s input field. May be empty, in which case only the bot’s username will be inserted. This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.

switch_inline_query_chosen_chat: Option<BoxWrapper<Unbox<SwitchInlineQueryChosenChat>>>

Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot’s username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.

callback_game: Option<BoxWrapper<Unbox<CallbackGame>>>

Optional. Description of the game that will be launched when the user presses the button. NOTE: This type of button must always be the first button in the first row.

pay: Option<bool>

Optional. Specify True, to send a Pay button. Substrings “⭐” and “XTR” in the buttons’s text will be replaced with a Telegram Star icon. NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.

Implementations

impl InlineKeyboardButtonBuilder

pub fn new(text: String) -> Self

pub fn set_text(self, text: String) -> Self

Label text on the button

pub fn set_url(self, url: String) -> Self

Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.

pub fn set_callback_data(self, callback_data: String) -> Self

Optional. Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes

pub fn set_web_app(self, web_app: WebAppInfo) -> Self

Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.

pub fn set_login_url(self, login_url: LoginUrl) -> Self

Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.

pub fn set_switch_inline_query(self, switch_inline_query: String) -> Self

Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot’s username and the specified inline query in the input field. May be empty, in which case just the bot’s username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.

pub fn set_switch_inline_query_current_chat( self, switch_inline_query_current_chat: String, ) -> Self

Optional. If set, pressing the button will insert the bot’s username and the specified inline query in the current chat’s input field. May be empty, in which case only the bot’s username will be inserted. This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.

pub fn set_switch_inline_query_chosen_chat( self, switch_inline_query_chosen_chat: SwitchInlineQueryChosenChat, ) -> Self

Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot’s username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.

pub fn set_callback_game(self, callback_game: CallbackGame) -> Self

Optional. Description of the game that will be launched when the user presses the button. NOTE: This type of button must always be the first button in the first row.

pub fn set_pay(self, pay: bool) -> Self

Optional. Specify True, to send a Pay button. Substrings “⭐” and “XTR” in the buttons’s text will be replaced with a Telegram Star icon. NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.

pub fn build(self) -> InlineKeyboardButton

Trait Implementations

impl Clone for InlineKeyboardButtonBuilder

fn clone(&self) -> InlineKeyboardButtonBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InlineKeyboardButtonBuilder

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

Formats the value using the given formatter.

impl Default for InlineKeyboardButtonBuilder

fn default() -> InlineKeyboardButtonBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InlineKeyboardButtonBuilder

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for InlineKeyboardButtonBuilder

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 Ord for InlineKeyboardButtonBuilder

fn cmp(&self, other: &InlineKeyboardButtonBuilder) -> 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 InlineKeyboardButtonBuilder

fn eq(&self, other: &InlineKeyboardButtonBuilder) -> 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 InlineKeyboardButtonBuilder

fn partial_cmp(&self, other: &InlineKeyboardButtonBuilder) -> 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 InlineKeyboardButtonBuilder

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 InlineKeyboardButtonBuilder

impl StructuralPartialEq for InlineKeyboardButtonBuilder