QOAuth2AuthorizationCodeFlow Class

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

頭: #include <QOAuth2AuthorizationCodeFlow>
qmake: QT += networkauth
Since: Qt 5.8
繼承: QAbstractOAuth2

特性

公共函數

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 )

靜態公共成員

const QMetaObject staticMetaObject

保護函數

QUrl buildAuthenticateUrl (const QVariantMap & 參數 = QVariantMap())
void requestAccessToken (const QString & code )

重實現保護函數

virtual void resourceOwnerAuthorization (const QUrl & url , const QVariantMap & 參數 = QVariantMap()) override

額外繼承成員

詳細描述

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

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 )

成員函數文檔編製

QOAuth2AuthorizationCodeFlow:: QOAuth2AuthorizationCodeFlow ( QObject * parent = nullptr)

構造 QOAuth2AuthorizationCodeFlow object with parent object parent .

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

構造 QOAuth2AuthorizationCodeFlow object using parent as parent and sets manager as the network access manager.

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

構造 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)

構造 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)

構造 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 .

[虛擬] QOAuth2AuthorizationCodeFlow:: ~QOAuth2AuthorizationCodeFlow ()

銷毀 QOAuth2AuthorizationCodeFlow 實例。

QUrl QOAuth2AuthorizationCodeFlow:: accessTokenUrl () const

Returns the URL used to request the access token.

注意: getter 函數對於特性 accessTokenUrl .

另請參閱 setAccessTokenUrl ().

[protected] QUrl QOAuth2AuthorizationCodeFlow:: buildAuthenticateUrl (const QVariantMap & 參數 = QVariantMap())

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.

另請參閱 : 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 QVariantMap & 參數 = QVariantMap())

重實現自 QAbstractOAuth::resourceOwnerAuthorization ().

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