From f13b7029e9af43282ebe6c2e9bb4dd749c8e450a Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Mon, 23 Jul 2018 02:09:18 +0300 Subject: Move docs to gh-pages branch --- docs/class_tg_bot_1_1_event_broadcaster.html | 523 --------------------------- 1 file changed, 523 deletions(-) delete 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 deleted file mode 100644 index 14396b5..0000000 --- a/docs/class_tg_bot_1_1_event_broadcaster.html +++ /dev/null @@ -1,523 +0,0 @@ - - - - - - -tgbot-cpp: TgBot::EventBroadcaster Class Reference - - - - - - - - - - - - - - - -
-
- - - - - - -
-
tgbot-cpp -
-
-
- - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
- -
-
TgBot::EventBroadcaster Class Reference
-
-
- -

This class holds all event listeners. - More...

- -

#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)
 Registers listener which receives all messages which the bot can ever receive. More...
 
void onCommand (const std::string &commandName, const MessageListener &listener)
 Registers listener which receives all messages with commands (messages with leading '/' char). More...
 
void onCommand (const std::initializer_list< std::string > &commandsList, const MessageListener &listener)
 Registers listener which receives all messages with commands (messages with leading '/' char). More...
 
void onUnknownCommand (const MessageListener &listener)
 Registers listener which receives all messages with commands (messages with leading '/' char) which haven't been handled by other listeners. More...
 
void onNonCommandMessage (const MessageListener &listener)
 Registers listener which receives all messages without commands (messages with no leading '/' char) More...
 
void onInlineQuery (const InlineQueryListener &listener)
 Registers listener which receives all the inline query. More...
 
void onChosenInlineResult (const ChosenInlineResultListener &listener)
 Registers listener which receives all the chosen inline result. More...
 
void onCallbackQuery (const CallbackQueryListener &listener)
 
-

Detailed Description

-

This class holds all event listeners.

- -

Definition at line 45 of file EventBroadcaster.h.

-

Member Typedef Documentation

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

Definition at line 53 of file EventBroadcaster.h.

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

Definition at line 52 of file EventBroadcaster.h.

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

Definition at line 51 of file EventBroadcaster.h.

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

Definition at line 50 of file EventBroadcaster.h.

- -
-
-

Member Function Documentation

- -
-
- - - - - -
- - - - - - - - -
void TgBot::EventBroadcaster::onAnyMessage (const MessageListenerlistener)
-
-inline
-
- -

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

-
Parameters
- - -
listenerListener.
-
-
- -

Definition at line 59 of file EventBroadcaster.h.

- -
-
- -
-
- - - - - -
- - - - - - - - -
void TgBot::EventBroadcaster::onCallbackQuery (const CallbackQueryListenerlistener)
-
-inline
-
- -

Definition at line 116 of file EventBroadcaster.h.

- -
-
- -
-
- - - - - -
- - - - - - - - -
void TgBot::EventBroadcaster::onChosenInlineResult (const ChosenInlineResultListenerlistener)
-
-inline
-
- -

Registers listener which receives all the chosen inline result.

-
Parameters
- - -
listenerListener.
-
-
- -

Definition at line 112 of file EventBroadcaster.h.

- -
-
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
void TgBot::EventBroadcaster::onCommand (const std::string & commandName,
const MessageListenerlistener 
)
-
-inline
-
- -

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

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

Definition at line 68 of file EventBroadcaster.h.

- -
-
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
void TgBot::EventBroadcaster::onCommand (const std::initializer_list< std::string > & commandsList,
const MessageListenerlistener 
)
-
-inline
-
- -

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

-
Parameters
- - - -
commandsListCommands names which listener can handle.
listenerListener.
-
-
- -

Definition at line 77 of file EventBroadcaster.h.

- -
-
- -
-
- - - - - -
- - - - - - - - -
void TgBot::EventBroadcaster::onInlineQuery (const InlineQueryListenerlistener)
-
-inline
-
- -

Registers listener which receives all the inline query.

-
Parameters
- - -
listenerListener.
-
-
- -

Definition at line 104 of file EventBroadcaster.h.

- -
-
- -
-
- - - - - -
- - - - - - - - -
void TgBot::EventBroadcaster::onNonCommandMessage (const MessageListenerlistener)
-
-inline
-
- -

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

-
Parameters
- - -
listenerListener.
-
-
- -

Definition at line 96 of file EventBroadcaster.h.

- -
-
- -
-
- - - - - -
- - - - - - - - -
void TgBot::EventBroadcaster::onUnknownCommand (const MessageListenerlistener)
-
-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 88 of file EventBroadcaster.h.

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