tgbot-cpp
Loading...
Searching...
No Matches
TgBot::ReplyKeyboardRemove Class Reference

Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. More...

#include <ReplyKeyboardRemove.h>

Inheritance diagram for TgBot::ReplyKeyboardRemove:
TgBot::GenericReply

Public Types

typedef std::shared_ptr< ReplyKeyboardRemovePtr
 
- Public Types inherited from TgBot::GenericReply
typedef std::shared_ptr< GenericReplyPtr
 

Public Attributes

const bool removeKeyboard = true
 Requests clients to remove the custom keyboard (user will not be able to summon this keyboard;.
 
bool selective = false
 Optional. 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 (has reply_to_message_id), sender of the original message.
 

Additional Inherited Members

- Public Member Functions inherited from TgBot::GenericReply
virtual ~GenericReply ()
 

Detailed Description

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).

Definition at line 18 of file ReplyKeyboardRemove.h.

Member Typedef Documentation

◆ Ptr

Definition at line 21 of file ReplyKeyboardRemove.h.

Member Data Documentation

◆ removeKeyboard

const bool TgBot::ReplyKeyboardRemove::removeKeyboard = true

Requests clients to remove the custom keyboard (user will not be able to summon this keyboard;.

if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)

Definition at line 28 of file ReplyKeyboardRemove.h.

◆ selective

bool TgBot::ReplyKeyboardRemove::selective = false

Optional. 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 (has reply_to_message_id), 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.

Definition at line 35 of file ReplyKeyboardRemove.h.


The documentation for this class was generated from the following file: