class Hamilton::Types::InlineKeyboardButton

Overview

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

Included Modules

Hamilton::Types::Common
JSON::Serializable

Defined in:

types/inline_keyboard_button.cr

Constructors

.new(pull : JSON::PullParser)
.new(params)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)
.new(**params)

Instance Method Summary

#callback_data : String | Nil
Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes.
#callback_data=(callback_data : String | Nil)
Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes.
#callback_game : Hamilton::Types::CallbackGame | Nil
Description of the game that will be launched when the user presses the button.
#callback_game=(callback_game : Hamilton::Types::CallbackGame | Nil)
Description of the game that will be launched when the user presses the button.
#copy_text : Hamilton::Types::CopyTextButton | Nil
Description of the button that copies the specified text to the clipboard.
#copy_text=(copy_text : Hamilton::Types::CopyTextButton | Nil)
Description of the button that copies the specified text to the clipboard.
#login_url : Hamilton::Types::LoginUrl | Nil
An HTTPS URL used to automatically authorize the user.
#login_url=(login_url : Hamilton::Types::LoginUrl | Nil)
An HTTPS URL used to automatically authorize the user.
#non_nil_fields : Array(String)
List of available non-nil fields.
#non_nil_fields=(non_nil_fields : Array(String))
List of available non-nil fields.
#pay : Bool | Nil
Specify True, to send a Pay button.
#pay=(pay : Bool | Nil)
Specify True, to send a Pay button.
#switch_inline_query : String | Nil
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.
#switch_inline_query=(switch_inline_query : String | Nil)
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.
#switch_inline_query_chosen_chat : Hamilton::Types::SwitchInlineQueryChosenChat | Nil
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.
#switch_inline_query_chosen_chat=(switch_inline_query_chosen_chat : Hamilton::Types::SwitchInlineQueryChosenChat | Nil)
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.
#switch_inline_query_current_chat : String | Nil
If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field.
#switch_inline_query_current_chat=(switch_inline_query_current_chat : String | Nil)
If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field.
#text : String
Label text on the button.
#text=(text : String)
Label text on the button.
#url : String | Nil
HTTP or tg:// URL to be opened when the button is pressed.
#url=(url : String | Nil)
HTTP or tg:// URL to be opened when the button is pressed.
#web_app : Hamilton::Types::WebAppInfo | Nil
Description of the Web App that will be launched when the user presses the button.
#web_app=(web_app : Hamilton::Types::WebAppInfo | Nil)
Description of the Web App that will be launched when the user presses the button.

Instance methods inherited from class `Reference`

Instance methods inherited from class `Object`

Constructor Detail

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

def self.new(params) #

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

def self.new(**params) #

Instance Method Detail

def callback_data : String | Nil #

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

def callback_data=(callback_data : String | Nil) #

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

def callback_game : Hamilton::Types::CallbackGame | Nil #

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.

def callback_game=(callback_game : Hamilton::Types::CallbackGame | Nil) #

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.

def copy_text : Hamilton::Types::CopyTextButton | Nil #

Description of the button that copies the specified text to the clipboard.

def copy_text=(copy_text : Hamilton::Types::CopyTextButton | Nil) #

Description of the button that copies the specified text to the clipboard.

def login_url : Hamilton::Types::LoginUrl | Nil #

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

def login_url=(login_url : Hamilton::Types::LoginUrl | Nil) #

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

def non_nil_fields : Array(String) #

List of available non-nil fields.

def non_nil_fields=(non_nil_fields : Array(String)) #

List of available non-nil fields.

def pay : Bool | Nil #

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.

def pay=(pay : Bool | Nil) #

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.

def switch_inline_query : String | Nil #

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 in channel direct messages chats and on behalf of a Telegram Business account.

def switch_inline_query=(switch_inline_query : String | Nil) #

def switch_inline_query_chosen_chat : Hamilton::Types::SwitchInlineQueryChosenChat | Nil #

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 in channel direct messages chats and on behalf of a Telegram Business account.

def switch_inline_query_chosen_chat=(switch_inline_query_chosen_chat : Hamilton::Types::SwitchInlineQueryChosenChat | Nil) #

def switch_inline_query_current_chat : String | Nil #

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 in channel direct messages chats and on behalf of a Telegram Business account.

def switch_inline_query_current_chat=(switch_inline_query_current_chat : String | Nil) #

def text : String #

Label text on the button.

def text=(text : String) #

Label text on the button.

def url : String | Nil #

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.

def url=(url : String | Nil) #

def web_app : Hamilton::Types::WebAppInfo | Nil #

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.

def web_app=(web_app : Hamilton::Types::WebAppInfo | Nil) #

hamilton