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

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. More...

#include <ForceReply.h>

Inheritance diagram for TgBot::ForceReply:
TgBot::GenericReply

Public Types

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

Public Attributes

const bool forceReply = true
 Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'.
 
std::string inputFieldPlaceholder
 Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters.
 
bool selective = false
 Optional. Use this parameter if you want to force reply from 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 replyToMessageId), 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 display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.

Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:

Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.

Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.

The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions — without any extra work for the user.

Definition at line 29 of file ForceReply.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<ForceReply> TgBot::ForceReply::Ptr

Definition at line 32 of file ForceReply.h.

Member Data Documentation

◆ forceReply

const bool TgBot::ForceReply::forceReply = true

Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'.

Definition at line 37 of file ForceReply.h.

◆ inputFieldPlaceholder

std::string TgBot::ForceReply::inputFieldPlaceholder

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

Definition at line 42 of file ForceReply.h.

◆ selective

bool TgBot::ForceReply::selective = false

Optional. Use this parameter if you want to force reply from 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 replyToMessageId), sender of the original message.

Definition at line 48 of file ForceReply.h.


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