qTbot::TelegramSingleRquest Class Reference

The TelegramSingleRquest class Is the base class for all single request commands with arguments. More...

#include <telegramsinglerquest.h>

Inheritance diagram for qTbot::TelegramSingleRquest:

Collaboration diagram for qTbot::TelegramSingleRquest:

Public Member Functions
	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...

Detailed Description

The TelegramSingleRquest class Is the base class for all single request commands with arguments.

Example: create a single request to telegram server.

#include "qTbot/messages/telegramsinglerquest.h"
 
class QTBOT_EXPORT TelegramGetMsg final: public TelegramSingleRquest
{
public:
    TelegramGetMsg();
};
 
TelegramGetMsg::TelegramGetMsg(int arg1):TelegramSingleRquest("getMe", {{"arg1", arg1}}) {}

Definition at line 36 of file telegramsinglerquest.h.

Constructor & Destructor Documentation

TelegramSingleRquest() [1/2]

qTbot::TelegramSingleRquest::TelegramSingleRquest	(	const QString &	request,
		const QMap< QString, QVariant > &	args )

TelegramSingleRquest This is the main constructor of the single requests.

Parameters

request	This is the request name (command)
args	This is the list of the request arguments.

Definition at line 17 of file telegramsinglerquest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

TelegramSingleRquest() [2/2]

qTbot::TelegramSingleRquest::TelegramSingleRquest

(

const QString &

request

)

TelegramSingleRquest This is the main constructor of the single requests.

Parameters

request

This is the request name (command)

Definition at line 23 of file telegramsinglerquest.cpp.

Here is the call graph for this function:

Member Function Documentation

baseAddress()

QString qTbot::TelegramSingleRquest::baseAddress ( ) const

overridevirtual

baseAddress This method returns the base domain of the remote server.

Returns

base domain name of the remote server.

Implements qTbot::iRequest.

Definition at line 27 of file telegramsinglerquest.cpp.

method()

iRequest::RequestMethod qTbot::TelegramSingleRquest::method ( ) const

overridevirtual

method returns the method of the request.

Returns

method of the request

Implements qTbot::iRequest.

Definition at line 31 of file telegramsinglerquest.cpp.

---

The documentation for this class was generated from the following files:

• src/qTbot/src/private/requests/telegramsinglerquest.h
• src/qTbot/src/private/requests/telegramsinglerquest.cpp