From b22c20c4db8c35eaee99075d055f74697c5805b8 Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Sun, 15 Jan 2017 02:33:59 +0300 Subject: Docs --- docs/d4/de1/class_tg_bot_1_1_force_reply.html | 194 ++++++++++++++++++++++++++ docs/d4/de1/class_tg_bot_1_1_force_reply.js | 6 + docs/d4/de1/class_tg_bot_1_1_force_reply.png | Bin 0 -> 599 bytes 3 files changed, 200 insertions(+) create mode 100644 docs/d4/de1/class_tg_bot_1_1_force_reply.html create mode 100644 docs/d4/de1/class_tg_bot_1_1_force_reply.js create mode 100644 docs/d4/de1/class_tg_bot_1_1_force_reply.png (limited to 'docs/d4/de1') diff --git a/docs/d4/de1/class_tg_bot_1_1_force_reply.html b/docs/d4/de1/class_tg_bot_1_1_force_reply.html new file mode 100644 index 0000000..4b716cc --- /dev/null +++ b/docs/d4/de1/class_tg_bot_1_1_force_reply.html @@ -0,0 +1,194 @@ + + + + + + + +tgbot-cpp: TgBot::ForceReply Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
tgbot-cpp +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Attributes | +List of all members
+
+
TgBot::ForceReply Class Reference
Types
+
+
+ +

#include <ForceReply.h>

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

+Public Types

typedef std::shared_ptr< ForceReply > Ptr
 
- Public Types inherited from TgBot::GenericReply
typedef std::shared_ptr< GenericReply > Ptr
 
+ + + + + +

+Public Attributes

const bool forceReply = true
 
bool selective = false
 
+ + + + +

+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 40 of file ForceReply.h.

+

Member Typedef Documentation

+ +

◆ Ptr

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

Definition at line 43 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 48 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 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.

+ +

Definition at line 53 of file ForceReply.h.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + diff --git a/docs/d4/de1/class_tg_bot_1_1_force_reply.js b/docs/d4/de1/class_tg_bot_1_1_force_reply.js new file mode 100644 index 0000000..5dacec4 --- /dev/null +++ b/docs/d4/de1/class_tg_bot_1_1_force_reply.js @@ -0,0 +1,6 @@ +var class_tg_bot_1_1_force_reply = +[ + [ "Ptr", "d4/de1/class_tg_bot_1_1_force_reply.html#a3d17d51e17dfdfd22d263bdeaf603b66", null ], + [ "forceReply", "d4/de1/class_tg_bot_1_1_force_reply.html#a8c4637ab74050185a86f5c058cf35de7", null ], + [ "selective", "d4/de1/class_tg_bot_1_1_force_reply.html#afbb510a24ebda5409311ff0d385065dc", null ] +]; \ No newline at end of file diff --git a/docs/d4/de1/class_tg_bot_1_1_force_reply.png b/docs/d4/de1/class_tg_bot_1_1_force_reply.png new file mode 100644 index 0000000..55f4b9d Binary files /dev/null and b/docs/d4/de1/class_tg_bot_1_1_force_reply.png differ -- cgit v1.2.3