qTbot 0.2.123.6f57966
qTbot is base back end library for your c++ Qt projects.
qTbot Namespace Reference

Classes

class  HttpException
 The HttpException class is the base exception that is raised on all errors of the HTTP protocol. More...
class  IBot
 The IBot class Base interface for all chat-bot objects. More...
class  IJsonBasedObject
 The IJsonBasedObject class This is base interface for all json base objects. More...
class  IJsonBasedUpdate
 The IJsonBasedUpdate class This is an update that has a json structure. More...
class  iMessage
 The iMessage class This is the main interface for all messages. More...
class  InternalException
 The InternalException class contains a string value to describe what happened. More...
class  iRequest
 The iRequest class Is main interface for all custom requests. More...
class  ITelegramBot
 The ITelegramBot class This is the base implementation of all telegram bots. More...
class  iUpdate
 The iUpdate class is the main interface for all update objects. More...
struct  TelegramArgs
 The TelegramArgs class is the base structure for all telegram message arguments. More...
class  TelegramAudio
 The TelegramAudio class This is implementation of the audio objects of telegram. More...
class  TelegramContact
 The telegramcontact class contains information about user contact. More...
class  TelegramDeleteMessage
 The TelegramDeleteMessage class prepares the deleteMessage request to remove a message with the selected id. More...
class  TelegramDocument
 The TelegramDocument class This is implementation of the documents objects of telegram. More...
class  TelegramEditMessage
 The TelegramEditMessage class This command edits the text and the keyboard of a message. More...
class  TelegramEditMessageReplyMarkup
 The TelegramEditMessageReplyMarkup class just edits the already created reply markups of a message. More...
class  TelegramFile
 The TelegramFile class is base class for all files. More...
class  TelegramGetFile
 The TelegramGetFile class builds an http request for getting files from the telegram messenger. More...
class  TelegramGetMe
 The TelegramGetMe class just prepares the getMe request to telegram. This request returns the basic information about the bot. More...
class  TelegramGetUpdate
 The TelegramGetUpdate class This is implementation of the get update method of the Telegram API. More...
class  TelegramImage
 The TelegramImage class This is implementation of the photos of telegram. More...
class  TelegramInlineKeyBoardCallBack
 The TelegramInlineKeyBoardCallBack class contains the data of a callback query that was received from an inline keyboard button. More...
class  TelegramLocation
 The TelegramLocation class is a simple struct with latitude and longitude. More...
class  TelegrammDownloadFile
 The TelegrammDownloadFile class prepares the link to download telegram files. More...
class  TelegramMsg
 The TelegramMsg class This class provides the general messages of telegram. The message object can contain text, geo data or a link to a video or image. All this data can be contained in one object. More...
class  TelegramRestBot
 The TelegramRestBot class Is the rest implementation base on the getUpdates (long polling) telegram method. The bot receives all updates from the telegram server by requesting them periodically. More...
class  TelegramSendContact
 The TelegramSendContact class prepares the sendContact request that sends a contact into the chat. More...
class  TelegramSendDocument
 The TelegramSendDocument class sends a document into the chat. More...
class  TelegramSendFile
 The TelegramSendFile class is the base class for uploading files to the server. More...
class  TelegramSendLocation
 The TelegramSendLocation class sends location data into the chat. More...
class  TelegramSendMsg
 The TelegramSendMsg class This method sends a message to the server. More...
class  TelegramSendPhoto
 The TelegramSendPhoto class is used for sending photos into the chat. More...
class  TelegramSingleRquest
 The TelegramSingleRquest class Is the base class for all single request commands with arguments. More...
class  TelegramUpdate
 The TelegramUpdate class contains base information about updates from telegram. More...
class  TelegramUpdateAnswer
 The TelegramUpdateAnswer class This is a base message from the telegram server after an update request. More...

Typedefs

typedef QHash< QString, QSharedPointer< QJsonObject > > ExtraJsonObjects
 ExtraJsonObjects hash map of the extra objects of the message.
typedef std::function< void(const QString &buttonKey, const QVariant &msgID)> ButtonCB
 ButtonCB callback type for inline keyboard buttons. It is invoked with the button key and the id of the message that contains the button.
typedef QList< QHash< QString, ButtonCB > > KeyboardOnMessage
 KeyboardOnMessage type. A list of rows where each row is a map of button keys to the callback function that is invoked when the button is pressed.

Functions

bool init ()
 init main initialize method of The qTbot library
QString version ()
 version This method return string value of a library version

Typedef Documentation

◆ ButtonCB

typedef std::function<void(const QString& buttonKey, const QVariant& msgID)> qTbot::ButtonCB

ButtonCB callback type for inline keyboard buttons. It is invoked with the button key and the id of the message that contains the button.

Definition at line 32 of file itelegrambot.h.

◆ ExtraJsonObjects

typedef QHash<QString, QSharedPointer<QJsonObject> > qTbot::ExtraJsonObjects

ExtraJsonObjects hash map of the extra objects of the message.

Definition at line 26 of file irequest.h.

◆ KeyboardOnMessage

typedef QList<QHash<QString, ButtonCB > > qTbot::KeyboardOnMessage

KeyboardOnMessage type. A list of rows where each row is a map of button keys to the callback function that is invoked when the button is pressed.

Definition at line 38 of file itelegrambot.h.

Function Documentation

◆ init()

bool QTBOT_EXPORT qTbot::init ( )

init main initialize method of The qTbot library

Returns
true if library initialized successfull

Definition at line 13 of file qTbot.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ version()

QString QTBOT_EXPORT qTbot::version ( )

version This method return string value of a library version

Returns
string value of a library version

Definition at line 18 of file qTbot.cpp.

Here is the call graph for this function:
Here is the caller graph for this function: