class Tourmaline::KeyboardButton

Overview

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_user, 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_user and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.

Included Modules

Defined in:

tourmaline/types/api.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(text : String, request_user : Tourmaline::KeyboardButtonRequestUser | Nil = nil, request_chat : Tourmaline::KeyboardButtonRequestChat | Nil = nil, request_contact : Bool | Nil = nil, request_location : Bool | Nil = nil, request_poll : Tourmaline::KeyboardButtonPollType | Nil = nil, web_app : Tourmaline::WebAppInfo | Nil = nil) #

[View source]

Instance Method Detail

def request_chat : Tourmaline::KeyboardButtonRequestChat | Nil #

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]
def request_chat=(request_chat : Tourmaline::KeyboardButtonRequestChat | Nil) #

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

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]
def request_contact? : Bool | Nil #

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

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


[View source]
def request_location? : Bool | Nil #

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


[View source]
def request_poll : Tourmaline::KeyboardButtonPollType | Nil #

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]
def request_poll=(request_poll : Tourmaline::KeyboardButtonPollType | Nil) #

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]
def request_user : Tourmaline::KeyboardButtonRequestUser | Nil #

Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a "user_shared" service message. Available in private chats only.


[View source]
def request_user=(request_user : Tourmaline::KeyboardButtonRequestUser | Nil) #

Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a "user_shared" service message. Available in private chats only.


[View source]
def 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]
def 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]
def web_app : Tourmaline::WebAppInfo | Nil #

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]
def web_app=(web_app : Tourmaline::WebAppInfo | Nil) #

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]