class Hamilton::Types::KeyboardButton

• Hamilton::Types::KeyboardButton
• Reference
• Object

Overview

This object represents one button of the reply keyboard. At most one of the fields other than text, #icon_custom_emoji_id, and #style must be used to specify the type of the button. For simple text buttons, String can be used instead of this object to specify the button text.

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

• Hamilton::Types::Common
• JSON::Serializable

Defined in:

types/keyboard_button.cr

Constructors

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

Instance Method Summary

• #icon_custom_emoji_id : String | Nil

  Unique identifier of the custom emoji shown before the text of the button.

• #icon_custom_emoji_id=(icon_custom_emoji_id : String | Nil)

  Unique identifier of the custom emoji shown before the text of the button.

• #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.

• #request_chat : Hamilton::Types::KeyboardButtonRequestChat | Nil

  If specified, pressing the button will open a list of suitable chats.

• #request_chat=(request_chat : Hamilton::Types::KeyboardButtonRequestChat | Nil)

  If specified, pressing the button will open a list of suitable chats.

• #request_contact : Bool | Nil

  If True, the user's phone number will be sent as a contact when the button is pressed.

• #request_contact=(request_contact : Bool | Nil)

  If True, the user's phone number will be sent as a contact when the button is pressed.

• #request_location : Bool | Nil

  If True, the user's current location will be sent when the button is pressed.

• #request_location=(request_location : Bool | Nil)

  If True, the user's current location will be sent when the button is pressed.

• #request_managed_bot : Hamilton::Types::KeyboardButtonRequestManagedBot | Nil

  If specified, pressing the button will ask the user to create and share a bot that will be managed by the current bot.

• #request_managed_bot=(request_managed_bot : Hamilton::Types::KeyboardButtonRequestManagedBot | Nil)

  If specified, pressing the button will ask the user to create and share a bot that will be managed by the current bot.

• #request_poll : Hamilton::Types::KeyboardButtonPollType | Nil

  If specified, the user will be asked to create a poll and send it to the bot when the button is pressed.

• #request_poll=(request_poll : Hamilton::Types::KeyboardButtonPollType | Nil)

  If specified, the user will be asked to create a poll and send it to the bot when the button is pressed.

• #request_users : Hamilton::Types::KeyboardButtonRequestUsers | Nil

  If specified, pressing the button will open a list of suitable users.

• #request_users=(request_users : Hamilton::Types::KeyboardButtonRequestUsers | Nil)

  If specified, pressing the button will open a list of suitable users.

• #style : String | Nil

  Style of the button.

• #style=(style : String | Nil)

  Style of the button.

• #text : String

  Text of the button.

• #text=(text : String)

  Text of the button.

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

  If specified, the described Web App will be launched when the button is pressed.

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

  If specified, the described Web App will be launched when the button is pressed.

Constructor Detail

Instance Method Detail