QAbstractOAuth2 Class

The QAbstractOAuth2 class is the base of all implementations of OAuth 2 authentication methods. More...

Header:	#include <QAbstractOAuth2>
qmake:	QT += networkauth
Since:	Qt 5.8
Inherits:	QAbstractOAuth
Inherited By:	QOAuth2AuthorizationCodeFlow

• List of all members, including inherited members
• Obsolete members

Properties

clientIdentifierSharedKey : QString expiration : const QDateTime refreshToken : QString

scope : QString state : QString userAgent : QString

• 6 properties inherited from QAbstractOAuth
• 1 property inherited from QObject

Public Functions

	QAbstractOAuth2(QObject *parent = nullptr)
	QAbstractOAuth2(QNetworkAccessManager *manager, QObject *parent = nullptr)
virtual	~QAbstractOAuth2()
QString	clientIdentifierSharedKey() const
virtual QUrl	createAuthenticatedUrl(const QUrl &url, const QVariantMap &parameters = ...)
QDateTime	expirationAt() const
virtual QNetworkReply *	post(const QUrl &url, const QByteArray &data)
virtual QNetworkReply *	post(const QUrl &url, QHttpMultiPart *multiPart)
virtual QNetworkReply *	put(const QUrl &url, const QByteArray &data)
virtual QNetworkReply *	put(const QUrl &url, QHttpMultiPart *multiPart)
QString	refreshToken() const
QString	responseType() const
QString	scope() const
void	setClientIdentifierSharedKey(const QString &clientIdentifierSharedKey)
void	setRefreshToken(const QString &refreshToken)
void	setScope(const QString &scope)
void	setState(const QString &state)
void	setUserAgent(const QString &userAgent)
QString	state() const
QString	userAgent() const

Reimplemented Public Functions

virtual QNetworkReply *	deleteResource(const QUrl &url, const QVariantMap &parameters = ...) override
virtual QNetworkReply *	get(const QUrl &url, const QVariantMap &parameters = ...) override
virtual QNetworkReply *	head(const QUrl &url, const QVariantMap &parameters = ...) override
virtual QNetworkReply *	post(const QUrl &url, const QVariantMap &parameters = ...) override
virtual QNetworkReply *	put(const QUrl &url, const QVariantMap &parameters = ...) override

• 21 public functions inherited from QAbstractOAuth
• 31 public functions inherited from QObject

Signals

void	authorizationCallbackReceived(const QVariantMap &data)
void	clientIdentifierSharedKeyChanged(const QString &clientIdentifierSharedKey)
void	error(const QString &error, const QString &errorDescription, const QUrl &uri)
void	expirationAtChanged(const QDateTime &expiration)
void	refreshTokenChanged(const QString &refreshToken)
void	responseTypeChanged(const QString &responseType)
void	scopeChanged(const QString &scope)
void	stateChanged(const QString &state)
void	userAgentChanged(const QString &userAgent)

• 11 signals inherited from QAbstractOAuth
• 2 signals inherited from QObject

Static Public Members

const QMetaObject

staticMetaObject

• 9 static public members inherited from QObject

Protected Functions

	QAbstractOAuth2(QAbstractOAuth2Private &, QObject *parent = nullptr)
void	setResponseType(const QString &responseType)

• 3 protected functions inherited from QAbstractOAuth
• 9 protected functions inherited from QObject

Additional Inherited Members

• 1 public slot inherited from QAbstractOAuth
• 1 public slot inherited from QObject
• 1 static protected member inherited from QAbstractOAuth

Detailed Description

The QAbstractOAuth2 class is the base of all implementations of OAuth 2 authentication methods.

The class defines the basic interface of the OAuth 2 authentication classes. By inheriting this class, you can create custom authentication methods using the OAuth 2 standard for different web services.

A description of how OAuth 2 works can be found in: The OAuth 2.0 Authorization Framework

Member Function Documentation

QAbstractOAuth2::QAbstractOAuth2(QObject *parent = nullptr)

Constructs a QAbstractOAuth2 object using parent as parent.

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

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

[protected] QAbstractOAuth2::QAbstractOAuth2(QAbstractOAuth2Private &, QObject *parent = nullptr)

Default constructs an instance of QAbstractOAuth2.

[virtual] QAbstractOAuth2::~QAbstractOAuth2()

Destroys the QAbstractOAuth2 instance.

[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.

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

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

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

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

Reimplemented from QAbstractOAuth::deleteResource().

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

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

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

Signal emitted when the server responds to the request with an error: error is the name of the error; errorDescription describes the error and uri is an optional URI containing more information about the error.

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

Reimplemented from QAbstractOAuth::get().

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

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

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

Reimplemented from QAbstractOAuth::head().

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

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

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

Reimplemented from QAbstractOAuth::post().

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

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

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

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}

This function was introduced in Qt 5.10.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

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

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

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}

This function was introduced in Qt 5.10.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

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

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

Reimplemented from QAbstractOAuth::put().

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

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

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

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}

This function was introduced in Qt 5.10.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

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

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

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}

This function was introduced in Qt 5.10.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

See also put(), QHttpMultiPart, 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.

Note: Getter function for property refreshToken.

See also setRefreshToken().

QString QAbstractOAuth2::responseType() const

Returns the response_type used.

See also setResponseType().

[signal] void QAbstractOAuth2::responseTypeChanged(const QString &responseType)

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().

Note: Setter function for property refreshToken.

See also refreshToken().

[protected] void QAbstractOAuth2::setResponseType(const QString &responseType)

See also responseType().