QOAuth2AuthorizationCodeFlow Class

The QOAuth2AuthorizationCodeFlow class provides an implementation of the Authorization Code Grant flow. 更多...

头：	#include <QOAuth2AuthorizationCodeFlow>
CMake:	find_package(Qt6 REQUIRED COMPONENTS NetworkAuth) target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth)
qmake:	QT += networkauth
继承：	QAbstractOAuth2

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

特性

accessTokenUrl : QUrl

公共函数

	QOAuth2AuthorizationCodeFlow (QObject * parent = nullptr)
	QOAuth2AuthorizationCodeFlow (QNetworkAccessManager * manager , QObject * parent = nullptr)
	QOAuth2AuthorizationCodeFlow (const QString & clientIdentifier , QNetworkAccessManager * manager , QObject * parent = nullptr)
	QOAuth2AuthorizationCodeFlow (const QUrl & authenticateUrl , const QUrl & accessTokenUrl , QNetworkAccessManager * manager , QObject * parent = nullptr)
	QOAuth2AuthorizationCodeFlow (const QString & clientIdentifier , const QUrl & authenticateUrl , const QUrl & accessTokenUrl , QNetworkAccessManager * manager , QObject * parent = nullptr)
virtual	~QOAuth2AuthorizationCodeFlow ()
QUrl	accessTokenUrl () const
void	setAccessTokenUrl (const QUrl & accessTokenUrl )

公共槽

virtual void	grant () override
void	refreshAccessToken ()

信号

void	accessTokenUrlChanged (const QUrl & accessTokenUrl )

保护函数

QUrl	buildAuthenticateUrl (const QMultiMap<QString, QVariant> & 参数 = {})
void	requestAccessToken (const QString & code )

重实现保护函数

virtual void

resourceOwnerAuthorization (const QUrl & url , const QMultiMap<QString, QVariant> & 参数 = {}) override

详细描述

This class implements the Authorization Code Grant flow, which is used both to obtain and to refresh access tokens. It is a redirection-based flow so the user will need access to a web browser.

特性文档编制

accessTokenUrl : QUrl

This property holds the URL used to convert the temporary code received during the authorization response.

另请参阅 : Access Token Request

访问函数：

QUrl	accessTokenUrl () const
void	setAccessTokenUrl (const QUrl & accessTokenUrl )

通知程序信号：

void	accessTokenUrlChanged (const QUrl & accessTokenUrl )

成员函数文档编制

`[explicit]` QOAuth2AuthorizationCodeFlow:: QOAuth2AuthorizationCodeFlow ( QObject * parent = nullptr)

Constructs a QOAuth2AuthorizationCodeFlow object with parent object parent .

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

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

QOAuth2AuthorizationCodeFlow:: QOAuth2AuthorizationCodeFlow (const QString & clientIdentifier , QNetworkAccessManager * manager , QObject * parent = nullptr)

Constructs a QOAuth2AuthorizationCodeFlow object using parent as parent and sets manager as the network access manager. The client identifier is set to clientIdentifier .

QOAuth2AuthorizationCodeFlow:: QOAuth2AuthorizationCodeFlow (const QUrl & authenticateUrl , const QUrl & accessTokenUrl , QNetworkAccessManager * manager , QObject * parent = nullptr)

Constructs a QOAuth2AuthorizationCodeFlow object using parent as parent and sets manager as the network access manager. The authenticate URL is set to authenticateUrl and the access token URL is set to accessTokenUrl .

QOAuth2AuthorizationCodeFlow:: QOAuth2AuthorizationCodeFlow (const QString & clientIdentifier , const QUrl & authenticateUrl , const QUrl & accessTokenUrl , QNetworkAccessManager * manager , QObject * parent = nullptr)

Constructs a QOAuth2AuthorizationCodeFlow object using parent as parent and sets manager as the network access manager. The client identifier is set to clientIdentifier the authenticate URL is set to authenticateUrl and the access token URL is set to accessTokenUrl .

`[virtual noexcept]` QOAuth2AuthorizationCodeFlow:: ~QOAuth2AuthorizationCodeFlow ()

销毁 QOAuth2AuthorizationCodeFlow 实例。

QUrl QOAuth2AuthorizationCodeFlow:: accessTokenUrl () const

Returns the URL used to request the access token.

注意： Getter function for property accessTokenUrl.

另请参阅 setAccessTokenUrl ().

`[protected]` QUrl QOAuth2AuthorizationCodeFlow:: buildAuthenticateUrl (const QMultiMap < QString , QVariant > & 参数 = {})

Generates an authentication URL to be used in the Authorization Request 使用参数 .

`[override virtual slot]` void QOAuth2AuthorizationCodeFlow:: grant ()

重实现： QAbstractOAuth::grant ().

Starts the authentication flow as described in The OAuth 2.0 Authorization Framework

`[slot]` void QOAuth2AuthorizationCodeFlow:: refreshAccessToken ()

Call this function to refresh the token. Access tokens are not permanent. After a time specified along with the access token when it was obtained, the access token will become invalid.

If refreshing the token fails and an access token exists, the status is set to QAbstractOAuth::Status::Granted , and to QAbstractOAuth::Status::NotAuthenticated 否则。

另请参阅 QAbstractOAuth::requestFailed () 和 Refresh Token .

`[protected]` void QOAuth2AuthorizationCodeFlow:: requestAccessToken (const QString & code )

Requests an access token from the received code 。 code is received as a response when the user completes a successful authentication in the browser.

`[override virtual protected]` void QOAuth2AuthorizationCodeFlow:: resourceOwnerAuthorization (const QUrl & url , const QMultiMap < QString , QVariant > & 参数 = {})

重实现： QAbstractOAuth::resourceOwnerAuthorization (const QUrl &url, const QMultiMap<QString, QVariant> ¶meters).

Builds an authentication URL using url and 参数 . This function emits an authorizeWithBrowser () signal to require user interaction.

void QOAuth2AuthorizationCodeFlow:: setAccessTokenUrl (const QUrl & accessTokenUrl )

Sets the URL used to request the access token to accessTokenUrl .

注意： setter 函数对于特性 accessTokenUrl .

另请参阅 accessTokenUrl ().