class Telegram::API::KeyboardButton
- Telegram::API::KeyboardButton
- Telegram::API::Type
- Reference
- Object
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.crConstructors
-
.new(pull : JSON::PullParser)
This object represents one button of the reply keyboard.
- .new(text : String, request_contact : Bool | Nil = nil, request_location : Bool | Nil = nil, request_poll : KeyboardButtonPollType | Nil = nil)
Instance Method Summary
-
#request_contact : Bool | Nil
Optional.
-
#request_contact=(request_contact : Bool | Nil)
Optional.
-
#request_location : Bool | Nil
Optional.
-
#request_location=(request_location : Bool | Nil)
Optional.
-
#request_poll : KeyboardButtonPollType | Nil
Optional.
-
#request_poll=(request_poll : KeyboardButtonPollType | Nil)
Optional.
-
#text : String
Text of the button.
-
#text=(text : String)
Text of the button.
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
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.
Instance Method Detail
Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only
Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only
Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only
Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only
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
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
Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed
Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed