qTbot::TelegramSendDocument Class Reference
The TelegramSendDocument class sends a document into the chat. More...
#include <telegramsenddocument.h>
Inheritance diagram for qTbot::TelegramSendDocument:
Collaboration diagram for qTbot::TelegramSendDocument:
Public Member Functions | |
| TelegramSendDocument (const TelegramArgs &args, const QString &fileName, const QByteArray &data, const ExtraJsonObjects &extraObjects={}) | |
| TelegramSendDocument prepares the send document request from a byte array. | |
| TelegramSendDocument (const TelegramArgs &args, const QFileInfo &file, const ExtraJsonObjects &extraObjects={}) | |
| TelegramSendDocument prepares the send document request from a file. | |
| Public Member Functions inherited from qTbot::TelegramSendFile | |
| TelegramSendFile (const QString &request, const QString &fileName, const QString &fileType, const QByteArray &data, const TelegramArgs &args, const QHash< QString, QSharedPointer< QJsonObject > > &extraObjects={}) | |
| TelegramSendFile prepares the send file request from a byte array. | |
| TelegramSendFile (const QString &request, const QFileInfo &file, const TelegramArgs &args, const QHash< QString, QSharedPointer< QJsonObject > > &extraObjects={}) | |
| TelegramSendFile prepares the send file request from a file. | |
| RequestMethod | method () const override |
| method Returns the method of the request. The file upload requests always use the Upload method. | |
| Public Member Functions inherited from qTbot::TelegramSingleRquest | |
| TelegramSingleRquest (const QString &request, const QMap< QString, QVariant > &args) | |
| TelegramSingleRquest This is the main constructor of the single requests. | |
| TelegramSingleRquest (const QString &request) | |
| TelegramSingleRquest This is the main constructor of the single requests. | |
| QString | baseAddress () const override |
| baseAddress This method returns the base domain of the remote server. | |
| RequestMethod | method () const override |
| method returns the method of the request. | |
| Public Member Functions inherited from qTbot::iRequest | |
| iRequest () | |
| iRequest default constructor. | |
| virtual QString | makeUpload () const |
| makeUpload This method prepares the data to upload. | |
| const QString & | request () const |
| request Returns the current request command. | |
| void | setRequest (const QString &newRequest) |
| setRequest sets a custom request command | |
| const QMap< QString, QVariant > & | args () const |
| args This method returns the the current list of arguments | |
| void | addArg (const QString &key, const QVariant &val) |
| addArg This method pushes a new argument to the arguments list | |
| void | setArgs (const QMap< QString, QVariant > &newArgs) |
| setArgs For some requests the list of arguments is possible to build only after the constructor. | |
| QString | argsToUrl () const |
| argsToUrl This method converts the arguments to a URL string. | |
| QSharedPointer< QHttpMultiPart > | argsToMultipartFormData () const |
| argsToMultipartFormData This method generates multipart/form-data request data. | |
| RequestPriority | priority () const |
| priority This is the priority of executing this request on the client. | |
| void | setPriority (RequestPriority newPriority) |
| setPriority This method sets a new priority for the request. | |
Additional Inherited Members | |
| Public Types inherited from qTbot::iRequest | |
| enum | RequestMethod { Get , Post , Upload } |
| RequestMethod This is the list of supported request types. More... | |
| enum | RequestPriority { NoPriority = 0 , LowPriority = 1 , NormalPriority = 2 , HighPriority = 3 , UngeredPriority = 4 , MaxPriorityValue = 0xff } |
| The RequestPriority enum This is the list of request execution priorities on the client side. More... | |
| Protected Member Functions inherited from qTbot::TelegramSendFile | |
| virtual QString | type () const |
| type Returns the file type. By default it is REQUEST_UPLOAD_FILE_KEY. | |
Detailed Description
The TelegramSendDocument class sends a document into the chat.
Definition at line 19 of file telegramsenddocument.h.
Constructor & Destructor Documentation
◆ TelegramSendDocument() [1/2]
| qTbot::TelegramSendDocument::TelegramSendDocument | ( | const TelegramArgs & | args, |
| const QString & | fileName, | ||
| const QByteArray & | data, | ||
| const ExtraJsonObjects & | extraObjects = {} ) |
TelegramSendDocument prepares the send document request from a byte array.
- Parameters
-
args This is the general arguments of the request (include the target chat id). fileName This is the displayed name of the document. data This is the document source data. extraObjects This is the additional objects of the telegram message (json).
Definition at line 11 of file telegramsenddocument.cpp.
Here is the call graph for this function:
◆ TelegramSendDocument() [2/2]
| qTbot::TelegramSendDocument::TelegramSendDocument | ( | const TelegramArgs & | args, |
| const QFileInfo & | file, | ||
| const ExtraJsonObjects & | extraObjects = {} ) |
TelegramSendDocument prepares the send document request from a file.
- Parameters
-
args This is the general arguments of the request (include the target chat id). file This is the file that contains the document. extraObjects This is the additional objects of the telegram message (json).
Definition at line 17 of file telegramsenddocument.cpp.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
- src/qTbot/src/private/requests/telegramsenddocument.h
- src/qTbot/src/private/requests/telegramsenddocument.cpp
