From d03eda27cdbe75470068d7513ecf510d8d342cf5 Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Sun, 15 Jan 2017 02:46:48 +0300 Subject: Docs --- docs/class_tg_bot_1_1_event_broadcaster.html | 449 +++++++++++++++++++++++++++ 1 file changed, 449 insertions(+) create mode 100644 docs/class_tg_bot_1_1_event_broadcaster.html (limited to 'docs/class_tg_bot_1_1_event_broadcaster.html') diff --git a/docs/class_tg_bot_1_1_event_broadcaster.html b/docs/class_tg_bot_1_1_event_broadcaster.html new file mode 100644 index 0000000..bf4632c --- /dev/null +++ b/docs/class_tg_bot_1_1_event_broadcaster.html @@ -0,0 +1,449 @@ + + + + + + + +tgbot-cpp: TgBot::EventBroadcaster Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
tgbot-cpp +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Member Functions | +List of all members
+
+
TgBot::EventBroadcaster Class Reference
General
+
+
+ +

#include <EventBroadcaster.h>

+ + + + + + + + + + +

+Public Types

typedef std::function< void(const Message::Ptr &)> MessageListener
 
typedef std::function< void(const InlineQuery::Ptr &)> InlineQueryListener
 
typedef std::function< void(const ChosenInlineResult::Ptr &)> ChosenInlineResultListener
 
typedef std::function< void(const CallbackQuery::Ptr &)> CallbackQueryListener
 
+ + + + + + + + + + + + + + + +

+Public Member Functions

void onAnyMessage (const MessageListener &listener)
 
void onCommand (const std::string &commandName, const MessageListener &listener)
 
void onUnknownCommand (const MessageListener &listener)
 
void onNonCommandMessage (const MessageListener &listener)
 
void onInlineQuery (const InlineQueryListener &listener)
 
void onChosenInlineResult (const ChosenInlineResultListener &listener)
 
void onCallbackQuery (const CallbackQueryListener &listener)
 
+

Detailed Description

+

This class holds all event listeners.

+ +

Definition at line 44 of file EventBroadcaster.h.

+

Member Typedef Documentation

+ +

◆ CallbackQueryListener

+ +
+
+ + + + +
typedef std::function<void (const CallbackQuery::Ptr&)> TgBot::EventBroadcaster::CallbackQueryListener
+
+ +

Definition at line 52 of file EventBroadcaster.h.

+ +
+
+ +

◆ ChosenInlineResultListener

+ +
+
+ + + + +
typedef std::function<void (const ChosenInlineResult::Ptr&)> TgBot::EventBroadcaster::ChosenInlineResultListener
+
+ +

Definition at line 51 of file EventBroadcaster.h.

+ +
+
+ +

◆ InlineQueryListener

+ +
+
+ + + + +
typedef std::function<void (const InlineQuery::Ptr&)> TgBot::EventBroadcaster::InlineQueryListener
+
+ +

Definition at line 50 of file EventBroadcaster.h.

+ +
+
+ +

◆ MessageListener

+ +
+
+ + + + +
typedef std::function<void (const Message::Ptr&)> TgBot::EventBroadcaster::MessageListener
+
+ +

Definition at line 49 of file EventBroadcaster.h.

+ +
+
+

Member Function Documentation

+ +

◆ onAnyMessage()

+ +
+
+ + + + + +
+ + + + + + + + +
void TgBot::EventBroadcaster::onAnyMessage (const MessageListener & listener)
+ 		+inline
+
+

Registers listener which receives all messages which the bot can ever receive.

Parameters
+ + +
listenerListener.
+
+
+ +

Definition at line 58 of file EventBroadcaster.h.

+ +
+
+ +

◆ onCallbackQuery()

+ +
+
+ + + + + +
+ + + + + + + + +
void TgBot::EventBroadcaster::onCallbackQuery (const CallbackQueryListener & listener)
+ 		+inline
+
+ +

Definition at line 103 of file EventBroadcaster.h.

+ +
+
+ +

◆ onChosenInlineResult()

+ +
+
+ + + + + +
+ + + + + + + + +
void TgBot::EventBroadcaster::onChosenInlineResult (const ChosenInlineResultListener & listener)
+ 		+inline
+
+

Registers listener which receives all the chosen inline result.

Parameters
+ + +
listenerListener.
+
+
+ +

Definition at line 99 of file EventBroadcaster.h.

+ +
+
+ +

◆ onCommand()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void TgBot::EventBroadcaster::onCommand (const std::string & commandName,
const MessageListener & listener 
)
+ 		+inline
+
+

Registers listener which receives all messages with commands (messages with leading '/' char).

Parameters
+ + + +
commandNameCommand name which listener can handle.
listenerListener.
+
+
+ +

Definition at line 67 of file EventBroadcaster.h.

+ +
+
+ +

◆ onInlineQuery()

+ +
+
+ + + + + +
+ + + + + + + + +
void TgBot::EventBroadcaster::onInlineQuery (const InlineQueryListener & listener)
+ 		+inline
+
+

Registers listener which receives all the inline query.

Parameters
+ + +
listenerListener.
+
+
+ +

Definition at line 91 of file EventBroadcaster.h.

+ +
+
+ +

◆ onNonCommandMessage()

+ +
+
+ + + + + +
+ + + + + + + + +
void TgBot::EventBroadcaster::onNonCommandMessage (const MessageListener & listener)
+ 		+inline
+
+

Registers listener which receives all messages without commands (messages with no leading '/' char)

Parameters
+ + +
listenerListener.
+
+
+ +

Definition at line 83 of file EventBroadcaster.h.

+ +
+
+ +

◆ onUnknownCommand()

+ +
+
+ + + + + +
+ + + + + + + + +
void TgBot::EventBroadcaster::onUnknownCommand (const MessageListener & listener)
+ 		+inline
+
+

Registers listener which receives all messages with commands (messages with leading '/' char) which haven't been handled by other listeners.

Parameters
+ + +
listenerListener.
+
+
+ +

Definition at line 75 of file EventBroadcaster.h.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.3