GramIO API Reference / @gramio/keyboards/dist / RemoveKeyboard

Class: RemoveKeyboard

Defined in: keyboards/index.d.ts:587

ReplyKeyboardRemove builder

Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).

[Documentation]

Constructors

Constructor

new RemoveKeyboard(): RemoveKeyboard

Returns

RemoveKeyboard

Properties

Property	Type	Defined in
options	object	keyboards/index.d.ts:588
options.isSelective	boolean	keyboards/index.d.ts:589

Methods

build()

build(): TelegramReplyKeyboardRemove

Defined in: keyboards/index.d.ts:605

Return TelegramReplyKeyboardRemove as object

Returns

TelegramReplyKeyboardRemove

---

selective()

selective(isEnabled?): this

Defined in: keyboards/index.d.ts:601

Use this parameter if you want to remove the keyboard for 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 votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.

Parameters

Parameter	Type
isEnabled?	boolean

Returns

this

Example

new RemoveKeyboard().selective(); // to enable
new RemoveKeyboard().selective(false); // to disable

---

toJSON()

toJSON(): TelegramReplyKeyboardRemove

Defined in: keyboards/index.d.ts:609

Serializing a class into an TelegramReplyKeyboardRemove object (used by JSON.stringify)

Returns

TelegramReplyKeyboardRemove