QAbstractOAuth2 Class

Member Function Documentation

[explicit] QAbstractOAuth2::QAbstractOAuth2(QObject *parent = nullptr)

Constructs a QAbstractOAuth2 object using parent as parent.

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

Constructs a QAbstractOAuth2 object using parent as parent and sets manager as the network access manager.

[virtual noexcept] QAbstractOAuth2::~QAbstractOAuth2()

Destroys the QAbstractOAuth2 instance.

[signal, since 6.9] void QAbstractOAuth2::accessTokenAboutToExpire()

The signal is emitted when the access token is about to expire.

Emitting this signal requires that the access token has a valid expiration time.

The developers who implement custom authorization flows by deriving from this class, should connect to this signal also in order to implement the auto-refresh functionality:

class MyClass : public QAbstractOAuth2
{
    Q_OBJECT
public:
    MyClass();
    void refreshAccessToken(); // issue a refresh request
public Q_SLOTS:
    void grant() override;
};
    ...
MyClass::MyClass() : QAbstractOAuth2()
{
    connect(this, &QAbstractOAuth2::accessTokenAboutToExpire, this, [this] {
        if (autoRefresh() && !refreshToken().isEmpty())
            refreshAccessToken();
    });
}

This function was introduced in Qt 6.9.

See also refreshThreshold and autoRefresh.

[signal] void QAbstractOAuth2::authorizationCallbackReceived(const QVariantMap &data)

Signal emitted when the reply server receives the authorization callback from the server: data contains the values received from the server.

void QAbstractOAuth2::clearNetworkRequestModifier()

Clears the network request modifier.

See also setNetworkRequestModifier().

[virtual invokable] QUrl QAbstractOAuth2::createAuthenticatedUrl(const QUrl &url, const QVariantMap &parameters = QVariantMap())

The returned URL is based on url, combining it with the given parameters and the access token.

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::deleteResource(const QUrl &url, const QVariantMap &parameters = QVariantMap())

This function is scheduled for deprecation in version 6.11.

Reimplements: QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap &parameters).

Please use QtNetwork classes directly instead, see HTTP method alternatives.

Sends an authenticated DELETE request and returns a new QNetworkReply. The url and parameters are used to create the request.

See also: Hypertext Transfer Protocol – HTTP/1.1: DELETE

[signal, until 6.13] void QAbstractOAuth2::error(const QString &error, const QString &errorDescription, const QUrl &uri)

This function is scheduled for deprecation in version 6.13.

Use serverReportedErrorOccurred instead

Signal emitted when the server responds to the authorization request with an error as defined in RFC 6749 error response.

error is the name of the error; errorDescription describes the error and uri is an optional URI containing more information about the error.

See also QAbstractOAuth::requestFailed() and QAbstractOAuth2::serverReportedErrorOccurred().

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::get(const QUrl &url, const QVariantMap &parameters = QVariantMap())

This function is scheduled for deprecation in version 6.11.

Reimplements: QAbstractOAuth::get(const QUrl &url, const QVariantMap &parameters).

Please use QtNetwork classes directly instead, see HTTP method alternatives.

Sends an authenticated GET request and returns a new QNetworkReply. The url and parameters are used to create the request.

See also: Hypertext Transfer Protocol – HTTP/1.1: GET

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::head(const QUrl &url, const QVariantMap &parameters = QVariantMap())

This function is scheduled for deprecation in version 6.11.

Reimplements: QAbstractOAuth::head(const QUrl &url, const QVariantMap &parameters).

Please use QtNetwork classes directly instead, see HTTP method alternatives.

Sends an authenticated HEAD request and returns a new QNetworkReply. The url and parameters are used to create the request.

See also: Hypertext Transfer Protocol – HTTP/1.1: HEAD

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QVariantMap &parameters = QVariantMap())

This function is scheduled for deprecation in version 6.11.

Reimplements: QAbstractOAuth::post(const QUrl &url, const QVariantMap &parameters).

Please use QtNetwork classes directly instead, see HTTP method alternatives.

Sends an authenticated POST request and returns a new QNetworkReply. The url and parameters are used to create the request.

See also: Hypertext Transfer Protocol – HTTP/1.1: POST

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, QHttpMultiPart *multiPart)

This function is scheduled for deprecation in version 6.11.

Please use QtNetwork classes directly instead, see HTTP method alternatives.

This is an overloaded function.

Sends an authenticated POST request and returns a new QNetworkReply. The url and multiPart are used to create the request.

{Hypertext Transfer Protocol – HTTP/1.1: POST}

See also post(), QHttpMultiPart, and https://tools.ietf.org/html/rfc2616#section-9.6.

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QByteArray &data)

This function is scheduled for deprecation in version 6.11.

Please use QtNetwork classes directly instead, see HTTP method alternatives.

This is an overloaded function.

Sends an authenticated POST request and returns a new QNetworkReply. The url and data are used to create the request.

{Hypertext Transfer Protocol – HTTP/1.1: POST}

See also post() and https://tools.ietf.org/html/rfc2616#section-9.6.

[override virtual] void QAbstractOAuth2::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray())

Reimplements: QAbstractOAuth::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body).

[override virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, const QVariantMap &parameters = QVariantMap())

This function is scheduled for deprecation in version 6.11.

Reimplements: QAbstractOAuth::put(const QUrl &url, const QVariantMap &parameters).

Please use QtNetwork classes directly instead, see HTTP method alternatives.

Sends an authenticated PUT request and returns a new QNetworkReply. The url and parameters are used to create the request.

See also: Hypertext Transfer Protocol – HTTP/1.1: PUT

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, QHttpMultiPart *multiPart)

This function is scheduled for deprecation in version 6.11.

Please use QtNetwork classes directly instead, see HTTP method alternatives.

This is an overloaded function.

Sends an authenticated PUT request and returns a new QNetworkReply. The url and multiPart are used to create the request.

{Hypertext Transfer Protocol – HTTP/1.1: PUT}

See also put(), QHttpMultiPart, and https://tools.ietf.org/html/rfc2616#section-9.6.

[virtual invokable, until 6.11] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, const QByteArray &data)

This function is scheduled for deprecation in version 6.11.

Please use QtNetwork classes directly instead, see HTTP method alternatives.

This is an overloaded function.

Sends an authenticated PUT request and returns a new QNetworkReply. The url and data are used to create the request.

{Hypertext Transfer Protocol – HTTP/1.1: PUT}

See also put() and https://tools.ietf.org/html/rfc2616#section-9.6.

QString QAbstractOAuth2::refreshToken() const

Gets the current refresh token.

Refresh tokens usually have longer lifespans than access tokens, so it makes sense to save them for later use.

Returns the current refresh token or an empty string, if there is no refresh token available.

See also setRefreshToken().

QString QAbstractOAuth2::responseType() const

Returns the response_type used.

[signal, since 6.9] void QAbstractOAuth2::serverReportedErrorOccurred(const QString &error, const QString &errorDescription, const QUrl &uri)

Signal emitted when the server responds to the authorization request with an error as defined in RFC 6749 error response.

error is the name of the error; errorDescription describes the error and uri is an optional URI containing more information about the error.

To catch all errors, including these RFC defined errors, with a single signal, use QAbstractOAuth::requestFailed().

This function was introduced in Qt 6.9.

[since 6.9] template <typename Functor, QAbstractOAuth2::if_compatible_callback<Functor> = true> void QAbstractOAuth2::setNetworkRequestModifier(const QAbstractOAuth2::ContextTypeForFunctor<Functor> *context, Functor &&callback)

Sets the network request modification function to callback. This function is used to customize the network requests sent to the server.

callback has to implement the signature void(QNetworkRequest&, QAbstractOAuth::Stage). The provided QNetworkRequest can be directly modified, and it is used right after the callback finishes. callback can be a function pointer, lambda, member function, or any callable object. The provided QAbstractOAuth::Stage can be used to check to which stage the request relates to (token request, token refresh request, or authorization request in case of QOAuth2DeviceAuthorizationFlow).

context controls the lifetime of the calls, and prevents access to de-allocated resources in case context is destroyed. In other words, if the object provided as context is destroyed, callbacks won't be executed. context must point to a valid QObject (and in case the callback is a member function, it needs to actually have it). Since the callback's results are used immediately, context must reside in the same thread as the QAbstractOAuth2 instance.

This function was introduced in Qt 6.9.

See also clearNetworkRequestModifier() and QNetworkRequest.

void QAbstractOAuth2::setRefreshToken(const QString &refreshToken)

Sets the new refresh token refreshToken to be used.

A custom refresh token can be used to refresh the access token via this method and then the access token can be refreshed via QOAuth2AuthorizationCodeFlow::refreshAccessToken().

See also refreshToken().

[since 6.5] void QAbstractOAuth2::setSslConfiguration(const QSslConfiguration &configuration)

Sets the TLS configuration to be used when establishing a mutual TLS connection between the client and the Authorization Server.

This function was introduced in Qt 6.5.

See also sslConfiguration() and sslConfigurationChanged().

[since 6.5] QSslConfiguration QAbstractOAuth2::sslConfiguration() const

Returns the TLS configuration to be used when establishing a mutual TLS connection between the client and the Authorization Server.

This function was introduced in Qt 6.5.

See also setSslConfiguration() and sslConfigurationChanged().

[signal, since 6.5] void QAbstractOAuth2::sslConfigurationChanged(const QSslConfiguration &configuration)

The signal is emitted when the TLS configuration has changed. The configuration parameter contains the new TLS configuration.

This function was introduced in Qt 6.5.

See also sslConfiguration() and setSslConfiguration().