class Telegram::API::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 text of the button. Optional fields 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.

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 the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields 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.


[View source]
def self.new(text : String, request_contact : Bool | Nil = nil, request_location : Bool | Nil = nil, request_poll : KeyboardButtonPollType | Nil = nil) #

[View source]

Instance Method Detail

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_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_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=(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 : 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 : 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 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]