QOAuth2AuthorizationCodeFlow Class
The QOAuth2AuthorizationCodeFlow class provides an implementation of the Authorization Code Grant flow. 更多...
| 头文件: | #include <QOAuth2AuthorizationCodeFlow> |
| qmake: | QT += networkauth |
| 开始支持版本: | Qt 5.8 |
| 基类: | QAbstractOAuth2 |
属性
- accessTokenUrl : QUrl
- 6 个属性继承自 QAbstractOAuth2
- 4 个属性继承自 QAbstractOAuth
- 1 个属性继承自 QObject
公有函数
| 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) | |
| ~QOAuth2AuthorizationCodeFlow() | |
| QUrl | accessTokenUrl() const |
| void | setAccessTokenUrl(const QUrl &accessTokenUrl) |
重新实现的公有函数
| virtual QString | responseType() const override |
- 19 个公有函数继承自 QAbstractOAuth2
- 20 个公有函数继承自 QAbstractOAuth
- 32 个公有函数继承自 QObject
公有槽函数
| virtual void | grant() override |
| void | refreshAccessToken() |
- 1 个公有槽函数继承自 QAbstractOAuth
- 1 个公有槽函数继承自 QObject
信号
| void | accessTokenUrlChanged(const QUrl &accessTokenUrl) |
- 8 个信号继承自 QAbstractOAuth2
- 11 个信号继承自 QAbstractOAuth
- 2 个信号继承自 QObject
受保护的函数
| QUrl | buildAuthenticateUrl(const QVariantMap ¶meters = QVariantMap()) |
| void | requestAccessToken(const QString &code) |
重新实现的受保护函数
| virtual void | resourceOwnerAuthorization(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
- 3 个受保护的函数继承自 QAbstractOAuth
- 9 个受保护的函数继承自 QObject
其他继承的成员
- 1 个公有变量继承自 QObject
- 10 个静态公有成员继承自 QObject
- 2 个受保护的变量继承自 QObject
- 1 static protected member inherited from QAbstractOAuth
详细描述
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.
访问函数:
| QUrl | accessTokenUrl() const |
| void | setAccessTokenUrl(const QUrl &accessTokenUrl) |
Notifier signal:
| void | accessTokenUrlChanged(const QUrl &accessTokenUrl) |
成员函数
QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(QObject *parent = nullptr)
Constructs a QOAuth2AuthorizationCodeFlow object with parent object parent.
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.
QOAuth2AuthorizationCodeFlow::~QOAuth2AuthorizationCodeFlow()
Destroys the QOAuth2AuthorizationCodeFlow instance.
QUrl QOAuth2AuthorizationCodeFlow::accessTokenUrl() const
Returns the URL used to request the access token.
Note: Getter function for property accessTokenUrl.
参见 setAccessTokenUrl().
[protected] QUrl QOAuth2AuthorizationCodeFlow::buildAuthenticateUrl(const QVariantMap ¶meters = QVariantMap())
Generates an authentication URL to be used in the Authorization Request using parameters.
[override virtual slot] void QOAuth2AuthorizationCodeFlow::grant()
Reimplemented from 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. The 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 ¶meters = QVariantMap())
Reimplemented from QAbstractOAuth::resourceOwnerAuthorization().
Builds an authentication URL using url and parameters. This function emits an authorizeWithBrowser() signal to require user interaction.
[override virtual] QString QOAuth2AuthorizationCodeFlow::responseType() const
Reimplemented from QAbstractOAuth2::responseType().
Returns the response_type used in QOAuth2AuthorizationCodeFlow; this is fixed to "code" as required in The OAuth 2.0 RFC
void QOAuth2AuthorizationCodeFlow::setAccessTokenUrl(const QUrl &accessTokenUrl)
Sets the URL used to request the access token to accessTokenUrl.
Note: Setter function for property accessTokenUrl.
参见 accessTokenUrl().