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

#include <ReplyKeyboardRemove.h>

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

+Public Types

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

+Public Attributes

const bool removeKeyboard = 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 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 20 of file ReplyKeyboardRemove.h.

+

Member Typedef Documentation

+ +

◆ Ptr

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

Definition at line 23 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 29 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 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: +
+
+ + + + diff --git a/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.js b/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.js new file mode 100644 index 0000000..1dbdfe8 --- /dev/null +++ b/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.js @@ -0,0 +1,6 @@ +var class_tg_bot_1_1_reply_keyboard_remove = +[ + [ "Ptr", "d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html#aaa58ef7c177db3a3f46530bfb5fc0148", null ], + [ "removeKeyboard", "d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html#a42b8b08952603a9566757bbe7d543408", null ], + [ "selective", "d0/dff/class_tg_bot_1_1_reply_keyboard_remove.html#a840a781ad230cee4c50057a7c7f82828", null ] +]; \ No newline at end of file diff --git a/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.png b/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.png new file mode 100644 index 0000000..cecb867 Binary files /dev/null and b/docs/d0/dff/class_tg_bot_1_1_reply_keyboard_remove.png differ -- cgit v1.2.3