class Tourmaline::ReplyKeyboardMarkup

Overview

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

Included Modules

Defined in:

tourmaline/types/api.cr
tourmaline/types/custom/reply_keyboard_markup.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

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

[View source]
def <<(keys : Array(KeyboardButton)) #

[View source]
def delete_row(row) #

[View source]
def input_field_placeholder : String | Nil #

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


[View source]
def input_field_placeholder=(input_field_placeholder : String | Nil) #

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


[View source]
def is_persistent=(is_persistent : Bool | Nil) #

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

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]
def keyboard : Array(Array(Tourmaline::KeyboardButton)) #

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


[View source]
def keyboard=(keyboard : Array(Array(Tourmaline::KeyboardButton))) #

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


[View source]
def one_time_keyboard=(one_time_keyboard : Bool | Nil) #

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

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

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

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

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 (has reply_to_message_id), 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]
def selective? : Bool | Nil #

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 (has reply_to_message_id), 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]
def size #

[View source]
def swap_row(row : Int32, keys : Array(KeyboardButton)) #

[View source]