class Hamilton::Types::ReplyKeyboardMarkup

Overview

This object represents a custom keyboard with reply options. Not supported in channels and for messages sent on behalf of a Telegram Business account.

Included Modules

Defined in:

types/reply_keyboard_markup.cr

Constructors

Instance Method Summary

Instance methods inherited from class Reference

==(other : Hamilton::Any) ==

Instance methods inherited from class Object

===(other : Hamilton::Any) ===

Constructor Detail

def self.new(pull : JSON::PullParser) #

def self.new(params) #

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

def self.new(**params) #

Instance Method Detail

def input_field_placeholder : String | Nil #

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


def input_field_placeholder=(input_field_placeholder : String | Nil) #

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


def is_persistent : Bool | Nil #

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.


def is_persistent=(is_persistent : Bool | Nil) #

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.


def keyboard : Array(Array(Hamilton::Types::KeyboardButton)) #

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


def keyboard=(keyboard : Array(Array(Hamilton::Types::KeyboardButton))) #

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


def non_nil_fields : Array(String) #

List of available non-nil fields.


def non_nil_fields=(non_nil_fields : Array(String)) #

List of available non-nil fields.


def one_time_keyboard : Bool | Nil #

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.


def one_time_keyboard=(one_time_keyboard : Bool | Nil) #

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.


def resize_keyboard : Bool | Nil #

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.


def resize_keyboard=(resize_keyboard : Bool | Nil) #

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.


def selective : Bool | Nil #

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.


def selective=(selective : Bool | Nil) #

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.