The QOAuth2AuthorizationCodeFlow class provides an implementation of the Authorization Code Grant flow. More...
| Header: | #include <QOAuth2AuthorizationCodeFlow> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS NetworkAuth) target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
| qmake: | QT += networkauth |
| Since: | Qt 5.8 |
| Inherits: | QAbstractOAuth2 |
| QOAuth2AuthorizationCodeFlow(const QString &clientIdentifier, const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| QOAuth2AuthorizationCodeFlow(const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| QOAuth2AuthorizationCodeFlow(const QString &clientIdentifier, QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| QOAuth2AuthorizationCodeFlow(QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| QOAuth2AuthorizationCodeFlow(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> ¶meters = {}) |
| void | requestAccessToken(const QString &code) |
| virtual void | resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> ¶meters = {}) 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.
This property holds the URL used to convert the temporary code received during the authorization response.
See also: Access Token Request
Access functions:
| QUrl | accessTokenUrl() const |
| void | setAccessTokenUrl(const QUrl &accessTokenUrl) |
Notifier signal:
| void | accessTokenUrlChanged(const QUrl &accessTokenUrl) |
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.
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.
Constructs a QOAuth2AuthorizationCodeFlow object using parent as parent and sets manager as the network access manager. The client identifier is set to clientIdentifier.
Constructs a QOAuth2AuthorizationCodeFlow object using parent as parent and sets manager as the network access manager.
Constructs a QOAuth2AuthorizationCodeFlow object with parent object parent.
[override virtual slot] void QOAuth2AuthorizationCodeFlow::grant()Reimplements: 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.
See also: Refresh Token
[virtual] QOAuth2AuthorizationCodeFlow::~QOAuth2AuthorizationCodeFlow()Destroys the QOAuth2AuthorizationCodeFlow instance.
Returns the URL used to request the access token.
Note: Getter function for property accessTokenUrl.
See also setAccessTokenUrl().
[protected] QUrl QOAuth2AuthorizationCodeFlow::buildAuthenticateUrl(const QMultiMap<QString, QVariant> ¶meters = {})Generates an authentication URL to be used in the Authorization Request using parameters.
[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 QMultiMap<QString, QVariant> ¶meters = {})Reimplements: QAbstractOAuth::resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> ¶meters).
Builds an authentication URL using url and parameters. This function emits an authorizeWithBrowser() signal to require user interaction.
Sets the URL used to request the access token to accessTokenUrl.
Note: Setter function for property accessTokenUrl.
See also accessTokenUrl().
