class Telegram::API::InlineKeyboardButton

Overview

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

Defined in:

telegram/api/generated/types.cr

Constructors

Instance Method Summary

Instance methods inherited from class Telegram::API::Type

==(other) ==, client client

Constructor methods inherited from class Telegram::API::Type

new(pull : JSON::PullParser) new

Constructor Detail

def self.new(pull : JSON::PullParser) #

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


[View source]
def self.new(text : String, url : String | Nil = nil, login_url : LoginUrl | Nil = nil, callback_data : String | Nil = nil, switch_inline_query : String | Nil = nil, switch_inline_query_current_chat : String | Nil = nil, callback_game : CallbackGame | Nil = nil, pay : Bool | Nil = nil) #

[View source]

Instance Method Detail

def callback_data : String | Nil #

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


[View source]
def callback_data=(callback_data : String | Nil) #

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


[View source]
def callback_game : CallbackGame | Nil #

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]
def callback_game=(callback_game : CallbackGame | Nil) #

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]
def login_url : LoginUrl | Nil #

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


[View source]
def login_url=(login_url : LoginUrl | Nil) #

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


[View source]
def pay : Bool | Nil #

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]
def pay=(pay : Bool | Nil) #

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]
def switch_inline_query : String | Nil #

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. Can be empty, in which case just the bot's username will be inserted. Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm... actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.


[View source]
def switch_inline_query=(switch_inline_query : String | Nil) #

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. Can be empty, in which case just the bot's username will be inserted. Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm... actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.


[View source]
def switch_inline_query_current_chat : String | Nil #

Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. Can 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.


[View source]
def switch_inline_query_current_chat=(switch_inline_query_current_chat : String | Nil) #

Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. Can 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.


[View source]
def text : String #

Label text on the button


[View source]
def text=(text : String) #

Label text on the button


[View source]
def url : String | Nil #

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 ID without using a username, if this is allowed by their privacy settings.


[View source]
def url=(url : String | Nil) #

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 ID without using a username, if this is allowed by their privacy settings.


[View source]