Skip to content

class Tourmaline::InlineKeyboardButton
inherits Reference #

This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

Included modules

JSON::Serializable

Constructors#

.new(pull : JSON::PullParser) #

View source

.new(text, url : String? = nil, callback_data : String? = nil, web_app : Tourmaline::WebAppInfo? = nil, login_url : Tourmaline::LoginUrl? = nil, switch_inline_query : String? = nil, switch_inline_query_current_chat : String? = nil, switch_inline_query_chosen_chat : Tourmaline::SwitchInlineQueryChosenChat? = nil, callback_game : Tourmaline::CallbackGame? = nil, pay : Bool? = nil) #

View source

Methods#

#callback_data : String? #

Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account.

View source

#callback_data=(callback_data : String?) #

Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account.

View source

#callback_game : Tourmaline::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.

View source

#callback_game=(callback_game : Tourmaline::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.

View source

#login_url : Tourmaline::LoginUrl? #

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

View source

#login_url=(login_url : Tourmaline::LoginUrl?) #

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

View source

#pay=(pay : Bool?) #

Optional. Specify True, to send a Pay button. NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.

View source

#pay? : Bool? #

Optional. Specify True, to send a Pay button. NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.

View source

#switch_inline_query : 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.

View source

#switch_inline_query=(switch_inline_query : 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.

View source

#switch_inline_query_chosen_chat : Tourmaline::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.

View source

#switch_inline_query_chosen_chat=(switch_inline_query_chosen_chat : Tourmaline::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.

View source

#switch_inline_query_current_chat : 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.

View source

#switch_inline_query_current_chat=(switch_inline_query_current_chat : 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.

View source

#text : String #

Label text on the button

View source

#text=(text : String) #

Label text on the button

View source

#url : 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.

View source

#url=(url : 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.

View source

#web_app : Tourmaline::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.

View source

#web_app=(web_app : Tourmaline::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.

View source