Skip to content

class Tourmaline::KeyboardButton
inherits Reference #

This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive. Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message. Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message. Note: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message. Note: request_users and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.

Included modules

JSON::Serializable

Constructors#

.new(pull : JSON::PullParser) #

View source

.new(text, request_users : Tourmaline::KeyboardButtonRequestUsers? = nil, request_chat : Tourmaline::KeyboardButtonRequestChat? = nil, request_contact : Bool? = nil, request_location : Bool? = nil, request_poll : Tourmaline::KeyboardButtonPollType? = nil, web_app : Tourmaline::WebAppInfo? = nil) #

View source

Methods#

#request_chat : Tourmaline::KeyboardButtonRequestChat? #

Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a "chat_shared" service message. Available in private chats only.

View source

#request_chat=(request_chat : Tourmaline::KeyboardButtonRequestChat?) #

Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a "chat_shared" service message. Available in private chats only.

View source

#request_contact=(request_contact : Bool?) #

Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

View source

#request_contact? : Bool? #

Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

View source

#request_location=(request_location : Bool?) #

Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.

View source

#request_location? : Bool? #

Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.

View source

#request_poll : Tourmaline::KeyboardButtonPollType? #

Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

View source

#request_poll=(request_poll : Tourmaline::KeyboardButtonPollType?) #

Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

View source

#request_users : Tourmaline::KeyboardButtonRequestUsers? #

Optional. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a "users_shared" service message. Available in private chats only.

View source

#request_users=(request_users : Tourmaline::KeyboardButtonRequestUsers?) #

Optional. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a "users_shared" service message. Available in private chats only.

View source

#text : String #

Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed

View source

#text=(text : String) #

Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed

View source

#web_app : Tourmaline::WebAppInfo? #

Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a "web_app_data" service message. Available in private chats only.

View source

#web_app=(web_app : Tourmaline::WebAppInfo?) #

Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a "web_app_data" service message. Available in private chats only.

View source