XX CMake Package
Loading...
Searching...
No Matches
XX::RestApi::Blocking Class Reference
Network

Blocking REST API client. More...

#include <XXRestApiBlocking.h>

Inheritance diagram for XX::RestApi::Blocking:
XX::Network::Settings XX::RestApi::Async

Detailed Description

Blocking REST API client.

Public Member Functions

 Blocking (QObject *parent, const QString &baseUrl)
virtual Result get (const QString &endpoint, const QUrlQuery &params=QUrlQuery()) const
virtual ResultRaw getRaw (const QString &endpoint, const QUrlQuery &params=QUrlQuery()) const
virtual Result post (const QString &endpoint, const QJsonObject &payload=QJsonObject(), const QUrlQuery &params=QUrlQuery()) const
virtual Result put (const QString &endpoint, const QJsonObject &payload=QJsonObject(), const QUrlQuery &params=QUrlQuery()) const
void setAuthProvider (AuthProvider::Token *newProvider)
void setBaseUrl (const QString &url)
const QString & getBaseUrl () const
Public Member Functions inherited from XX::Network::Settings
 Settings ()
void setVerbose (bool enabled)
bool verbose () const

Protected Types

using ReplyGeneratorFunction = std::function<QNetworkReply*(QNetworkRequest request)>

Protected Member Functions

void addUnauthorizedStatusCode (int code)
QNetworkRequest createRequest (const QString &endpoint, const QUrlQuery &params) const

Protected Attributes

QNetworkAccessManager * manager
QList< int > successStatusCodes
QList< int > unauthorizedStatusCodes
AuthProvider::Token * provider
QString baseUrl

Friends

class Async

Additional Inherited Members

Static Public Member Functions inherited from XX::Network::Settings
static void setUseExceptions (bool enabled)
static bool useExceptions ()

Member Typedef Documentation

◆ ReplyGeneratorFunction

using XX::RestApi::Blocking::ReplyGeneratorFunction = std::function<QNetworkReply*(QNetworkRequest request)>
protected

Constructor & Destructor Documentation

◆ Blocking()

XX::RestApi::Blocking::Blocking ( QObject * parent,
const QString & baseUrl )

Member Function Documentation

◆ addUnauthorizedStatusCode()

void XX::RestApi::Blocking::addUnauthorizedStatusCode ( int code)
protected

◆ createRequest()

QNetworkRequest XX::RestApi::Blocking::createRequest ( const QString & endpoint,
const QUrlQuery & params ) const
protected

◆ get()

virtual Result XX::RestApi::Blocking::get ( const QString & endpoint,
const QUrlQuery & params = QUrlQuery() ) const
virtual

◆ getBaseUrl()

const QString & XX::RestApi::Blocking::getBaseUrl ( ) const

◆ getRaw()

virtual ResultRaw XX::RestApi::Blocking::getRaw ( const QString & endpoint,
const QUrlQuery & params = QUrlQuery() ) const
virtual

◆ post()

virtual Result XX::RestApi::Blocking::post ( const QString & endpoint,
const QJsonObject & payload = QJsonObject(),
const QUrlQuery & params = QUrlQuery() ) const
virtual

◆ put()

virtual Result XX::RestApi::Blocking::put ( const QString & endpoint,
const QJsonObject & payload = QJsonObject(),
const QUrlQuery & params = QUrlQuery() ) const
virtual

◆ setAuthProvider()

void XX::RestApi::Blocking::setAuthProvider ( AuthProvider::Token * newProvider)

◆ setBaseUrl()

void XX::RestApi::Blocking::setBaseUrl ( const QString & url)

◆ Async

friend class Async
friend

Member Data Documentation

◆ baseUrl

QString XX::RestApi::Blocking::baseUrl
protected

◆ manager

QNetworkAccessManager* XX::RestApi::Blocking::manager
protected

◆ provider

AuthProvider::Token* XX::RestApi::Blocking::provider
protected

◆ successStatusCodes

QList<int> XX::RestApi::Blocking::successStatusCodes
protected

◆ unauthorizedStatusCodes

QList<int> XX::RestApi::Blocking::unauthorizedStatusCodes
protected
The documentation for this class was generated from the following file: