Skip to content

class Tourmaline::ReplyKeyboardMarkup
inherits Reference #

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

Included modules

JSON::Serializable

Constructors#

.new(keyboard : Array(Array(Tourmaline::KeyboardButton)) = [] of Array(Tourmaline::KeyboardButton), is_persistent : Bool? = nil, resize_keyboard : Bool? = nil, one_time_keyboard : Bool? = nil, input_field_placeholder : String? = nil, selective : Bool? = nil) #

View source

.new(pull : JSON::PullParser) #

View source

Methods#

#<<(keys : Array(KeyboardButton)) #

View source

#<<(row : Int32, key : KeyboardButton) #

View source

#delete_row(row) #

View source

#input_field_placeholder : String? #

Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters

View source

#input_field_placeholder=(input_field_placeholder : String?) #

Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters

View source

#is_persistent=(is_persistent : Bool?) #

Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.

View source

#is_persistent? : Bool? #

Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.

View source

#keyboard : Array(Array(Tourmaline::KeyboardButton)) #

Array of button rows, each represented by an Array of KeyboardButton objects

View source

#keyboard=(keyboard : Array(Array(Tourmaline::KeyboardButton))) #

Array of button rows, each represented by an Array of KeyboardButton objects

View source

#one_time_keyboard=(one_time_keyboard : Bool?) #

Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.

View source

#one_time_keyboard? : Bool? #

Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.

View source

#resize_keyboard=(resize_keyboard : Bool?) #

Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.

View source

#resize_keyboard? : Bool? #

Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.

View source

#selective=(selective : Bool?) #

Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message. Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.

View source

#selective? : Bool? #

Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message. Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.

View source

#size #

View source

#swap_row(row : Int32, keys : Array(KeyboardButton)) #

View source