QRestAccessManager Class

Member Function Documentation

[explicit] QRestAccessManager::QRestAccessManager(QNetworkAccessManager *manager, QObject *parent = nullptr)

Constructs a QRestAccessManager object and sets parent as the parent object, and manager as the underlying QNetworkAccessManager which is used for communication.

See also networkAccessManager().

[override virtual noexcept] QRestAccessManager::~QRestAccessManager()

Destroys the QRestAccessManager object.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::deleteResource(const QNetworkRequest &request, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Issues an HTTP DELETE based on request.

The optional callback and context object can be provided for handling the request completion as illustrated below:

manager->deleteResource(request, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Alternatively the signals of the returned QNetworkReply* object can be used. For further information see Issuing Network Requests and Handling Replies.

deleteResource() request does not support providing data.

See also QRestReply.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Issues an HTTP GET based on request.

The optional callback and context object can be provided for handling the request completion as illustrated below:

manager->get(request, this, [this](QRestReply &reply) {
    if (!reply.isSuccess())
        // handle error
    if (std::optional json = reply.readJson())
        // use *json
});

Alternatively the signals of the returned QNetworkReply* object can be used. For further information see Issuing Network Requests and Handling Replies.

See also QRestReply.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Issues an HTTP GET based on request and provided data.

The optional callback and context object can be provided for handling the request completion as illustrated below:

manager->get(request, myData, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Alternatively the signals of the returned QNetworkReply* object can be used. For further information see Issuing Network Requests and Handling Replies.

See also QRestReply.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::get(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::head(const QNetworkRequest &request, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Issues an HTTP HEAD based on request.

The optional callback and context object can be provided for handling the request completion as illustrated below:

manager->head(request, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Alternatively the signals of the returned QNetworkReply* object can be used. For further information see Issuing Network Requests and Handling Replies.

head() request does not support providing data.

See also QRestReply.

QNetworkAccessManager *QRestAccessManager::networkAccessManager() const

Returns the underlying QNetworkAccessManager instance.

See also QNetworkAccessManager.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Issues an HTTP PATCH based on request.

The optional callback and context object can be provided for handling the request completion as illustrated below:

manager->patch(request, myData, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Alternatively the signals of the returned QNetworkReply* object can be used. For further information see Issuing Network Requests and Handling Replies.

The patch() method always requires data parameter. The following data types are supported:

• QByteArray
• QJsonDocument *)
• QVariantMap **)
• QIODevice*

*) Sent in QJsonDocument::Compact format, and the Content-Type header is set to application/json if the Content-Type header was not set **) QVariantMap is converted to and treated as a QJsonObject

See also QRestReply.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::patch(const QNetworkRequest &request, const QVariantMap &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Issues an HTTP POST based on request.

The optional callback and context object can be provided for handling the request completion as illustrated below:

manager->post(request, myData, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Alternatively, the signals of the returned QNetworkReply* object can be used. For further information see Issuing Network Requests and Handling Replies.

The post() method always requires data parameter. The following data types are supported:

• QByteArray
• QJsonDocument *)
• QVariantMap **)
• QHttpMultiPart*
• QIODevice*

*) Sent in QJsonDocument::Compact format, and the Content-Type header is set to application/json if the Content-Type header was not set **) QVariantMap is converted to and treated as a QJsonObject

See also QRestReply.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, QHttpMultiPart *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::post(const QNetworkRequest &request, const QVariantMap &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, const QJsonDocument &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Issues an HTTP PUT based on request.

The optional callback and context object can be provided for handling the request completion as illustrated below:

manager->put(request, myData, this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Alternatively the signals of the returned QNetworkReply* object can be used. For further information see Issuing Network Requests and Handling Replies.

The put() method always requires data parameter. The following data types are supported:

• QByteArray
• QJsonDocument *)
• QVariantMap **)
• QHttpMultiPart*
• QIODevice*

*) Sent in QJsonDocument::Compact format, and the Content-Type header is set to application/json if the Content-Type header was not set **) QVariantMap is converted to and treated as a QJsonObject

See also QRestReply.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, QHttpMultiPart *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::put(const QNetworkRequest &request, const QVariantMap &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, const QByteArray &data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Issues request based HTTP request with custom method and the provided data.

The optional callback and context object can be provided for handling the request completion as illustrated below:

manager->sendCustomRequest(request, "MYMETHOD",  myData,  this, [this](QRestReply &reply) {
    if (reply.isSuccess())
        // ...
});

Alternatively the signals of the returned QNetworkReply* object can be used. For further information see Issuing Network Requests and Handling Replies.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, QHttpMultiPart *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.

template <typename Functor, QRestAccessManager::if_compatible_callback<Functor> > QNetworkReply *QRestAccessManager::sendCustomRequest(const QNetworkRequest &request, const QByteArray &method, QIODevice *data, const QRestAccessManager::ContextTypeForFunctor<Functor> *context, Functor &&callback)

This is an overloaded function.