内容

• 特性
• 公共函数
• 重实现公共函数
• 信号
• 保护函数
• 详细描述

QAbstractOAuth2 Class

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

头：	#include <QAbstractOAuth2>
qmake:	QT += networkauth
Since:	Qt 5.8
继承：	QAbstractOAuth
继承者：	QOAuth2AuthorizationCodeFlow

• 所有成员列表，包括继承成员

特性

clientIdentifier : QString clientIdentifierSharedKey : QString expiration : const QDateTime

scope : QString state : QString userAgent : QString

• 4 特性继承自 QAbstractOAuth
• 1 特性继承自 QObject

公共函数

	QAbstractOAuth2 (QObject * parent = nullptr)
	QAbstractOAuth2 (QNetworkAccessManager * manager , QObject * parent = nullptr)
	~QAbstractOAuth2 ()
QString	clientIdentifierSharedKey () const
virtual QUrl	createAuthenticatedUrl (const QUrl & url , const QVariantMap & 参数 = QVariantMap())
QDateTime	expirationAt () const
virtual QString	responseType () const = 0
QString	scope () const
void	setClientIdentifierSharedKey (const QString & clientIdentifierSharedKey )
void	setScope (const QString & scope )
void	setState (const QString & state )
void	setUserAgent (const QString & userAgent )
QString	state () const
QString	userAgent () const

重实现公共函数

virtual QString	clientIdentifier () const override
virtual QNetworkReply *	deleteResource (const QUrl & url , const QVariantMap & 参数 = QVariantMap()) override
virtual QNetworkReply *	get (const QUrl & url , const QVariantMap & 参数 = QVariantMap()) override
virtual QNetworkReply *	head (const QUrl & url , const QVariantMap & 参数 = QVariantMap()) override
virtual QNetworkReply *	post (const QUrl & url , const QVariantMap & 参数 = QVariantMap()) override
virtual void	setClientIdentifier (const QString & clientIdentifier ) override
virtual void	setToken (const QString & token ) override
virtual QString	token () const override

• 20 公共函数继承自 QAbstractOAuth
• 32 公共函数继承自 QObject

信号

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

• 11 signals inherited from QAbstractOAuth
• 2 信号继承自 QObject

保护函数

QAbstractOAuth2 ( QAbstractOAuth2Private & , QObject * parent = nullptr)

• 3 保护函数继承自 QAbstractOAuth
• 9 保护函数继承自 QObject

额外继承成员

• 1 公共槽继承自 QAbstractOAuth
• 1 公共槽继承自 QObject
• 11 静态公共成员继承自 QObject
• 1 static protected member inherited from QAbstractOAuth

详细描述

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

特性文档编制

clientIdentifier : QString

This property holds the client identifier used to identify the application in the authentication process.

访问函数：

virtual QString	clientIdentifier () const override
virtual void	setClientIdentifier (const QString & clientIdentifier ) override

通知程序信号：

void	clientIdentifierChanged (const QString & clientIdentifier )

clientIdentifierSharedKey : QString

This property holds the client shared key used as a password if the server requires authentication to request the token.

访问函数：

QString	clientIdentifierSharedKey () const
void	setClientIdentifierSharedKey (const QString & clientIdentifierSharedKey )

通知程序信号：

void	clientIdentifierSharedKeyChanged (const QString & clientIdentifierSharedKey )

expiration : const QDateTime

This property holds the expiration time of the current access token.

访问函数：

QDateTime

expirationAt () const

通知程序信号：

void	expirationAtChanged (const QDateTime & expiration )

scope : QString

This property holds the desired scope which defines the permissions requested by the client.

访问函数：

QString	scope () const
void	setScope (const QString & scope )

通知程序信号：

void	scopeChanged (const QString & scope )

state : QString

This property holds the string sent to the server during authentication. The state is used to identify and validate the request when the callback is received.

访问函数：

QString	state () const
void	setState (const QString & state )

通知程序信号：

void	stateChanged (const QString & state )

userAgent : QString

This property holds the User-Agent header used to create the network requests.

The default value is "QtOAuth/1.0 (+https://www.qt.io)".

访问函数：

QString	userAgent () const
void	setUserAgent (const QString & userAgent )

通知程序信号：

void	userAgentChanged (const QString & userAgent )

成员函数文档编制

QAbstractOAuth2:: QAbstractOAuth2 ( QObject * parent = nullptr)

构造 QAbstractOAuth2 object using parent 作为父级。

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

构造 QAbstractOAuth2 object using parent as parent and sets manager as the network access manager.

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

Copy constructor.

QAbstractOAuth2:: ~QAbstractOAuth2 ()

销毁 QAbstractOAuth2 实例。

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

[虚拟] QUrl QAbstractOAuth2:: createAuthenticatedUrl (const QUrl & url , const QVariantMap & 参数 = QVariantMap())

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

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

重实现自 QAbstractOAuth::deleteResource ().

Sends an authenticated DELETE request and returns a new QNetworkReply 。 url and 参数 are used to create the request.

另请参阅 : Hypertext Transfer Protocol -- HTTP/1.1: DELETE

[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 & 参数 = QVariantMap())

重实现自 QAbstractOAuth::get ().

Sends an authenticated GET request and returns a new QNetworkReply 。 url and 参数 are used to create the request.

另请参阅 : Hypertext Transfer Protocol -- HTTP/1.1: GET

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

重实现自 QAbstractOAuth::head ().

Sends an authenticated HEAD request and returns a new QNetworkReply 。 url and 参数 are used to create the request.

另请参阅 : Hypertext Transfer Protocol -- HTTP/1.1: HEAD

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

重实现自 QAbstractOAuth::post ().

Sends an authenticated POST request and returns a new QNetworkReply 。 url and 参数 are used to create the request.

另请参阅 : Hypertext Transfer Protocol -- HTTP/1.1: POST

[pure virtual] QString QAbstractOAuth2:: responseType () const

[override virtual] void QAbstractOAuth2:: setToken (const QString & token )

另请参阅 token ().

[override virtual] QString QAbstractOAuth2:: token () const

另请参阅 setToken ().