Класс QOAuth2AuthorizationCodeFlow
Класс QOAuth2AuthorizationCodeFlow предоставляет реализацию потока Authorization Code Grant. Подробнее...
| Заголовок: | #include <QOAuth2AuthorizationCodeFlow> |
| CMake: | find_package(Qt6 COMPONENTS NetworkAuth REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
| qmake: | QT += networkauth |
| С момента: | Qt 5.8 |
| Наследует: | QAbstractOAuth2 |
Свойства
- accessTokenUrl : QUrl
Открытые функции
| 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 |
Подробное описание
Этот класс реализует поток Authorization Code Grant, который используется для получения и обновления токенов доступа. Это поток на основе перенаправления, поэтому пользователю потребуется доступ к веб-браузеру.
Документация по свойствам
accessTokenUrl : QUrl
Это свойство хранит URL, используемый для преобразования временного кода, полученного во время ответа на авторизацию.
См. также: Запрос токена доступа
Функции доступа:
| QUrl | accessTokenUrl() const |
| void | setAccessTokenUrl(const QUrl &accessTokenUrl) |
Сигнал уведомления:
| void | accessTokenUrlChanged(const QUrl &accessTokenUrl) |
Документация по функциям-членам
QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(const QString &clientIdentifier, const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr)
Создает объект QOAuth2AuthorizationCodeFlow с родительским объектом parent и устанавливает manager в качестве менеджера сетевого доступа. Идентификатор клиента устанавливается в clientIdentifier, URL для аутентификации — в authenticateUrl, а URL для токена доступа — в accessTokenUrl.
QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr)
Создаёт объект QOAuth2AuthorizationCodeFlow с родительским объектом parent и устанавливает manager в качестве менеджера сетевого доступа. URL для аутентификации устанавливается в authenticateUrl, а URL для токена доступа — в accessTokenUrl.
QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(const QString &clientIdentifier, QNetworkAccessManager *manager, QObject *parent = nullptr)
Создаёт объект QOAuth2AuthorizationCodeFlow с родительским объектом parent и устанавливает manager в качестве менеджера сетевого доступа. Идентификатор клиента устанавливается в clientIdentifier.
QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(QNetworkAccessManager *manager, QObject *parent = nullptr)
Создает объект QOAuth2AuthorizationCodeFlow с родительским объектом parent и устанавливает manager в качестве менеджера сетевого доступа.
QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(QObject *parent = nullptr)
Создает объект QOAuth2AuthorizationCodeFlow с родительским объектом parent.
[override virtual slot] void QOAuth2AuthorizationCodeFlow::grant()
Переопределяет: QAbstractOAuth::grant().
Запускает поток аутентификации, как описано в OAuth 2.0 Authorization Framework.
[slot] void QOAuth2AuthorizationCodeFlow::refreshAccessToken()
Вызовите эту функцию для обновления токена. Токены доступа не постоянны. По истечении времени, указанного вместе с токеном доступа при его получении, токен доступа станет недействительным.
См. также: Токен обновления
[virtual] QOAuth2AuthorizationCodeFlow::~QOAuth2AuthorizationCodeFlow()
Уничтожает экземпляр QOAuth2AuthorizationCodeFlow.
QUrl QOAuth2AuthorizationCodeFlow::accessTokenUrl() const
Возвращает URL, используемый для запроса токена доступа.
Примечание: Функция-получатель для свойства accessTokenUrl.
См. также setAccessTokenUrl().
[protected] QUrl QOAuth2AuthorizationCodeFlow::buildAuthenticateUrl(const QMultiMap<QString, QVariant> ¶meters = {})
Генерирует URL для аутентификации, используемый в Запросе авторизации с использованием parameters.
[protected] void QOAuth2AuthorizationCodeFlow::requestAccessToken(const QString &code)
Запрашивает токен доступа по полученному code. code получен в ответ, когда пользователь успешно завершил аутентификацию в браузере.
[override virtual protected] void QOAuth2AuthorizationCodeFlow::resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> ¶meters = {})
Переопределяет: QAbstractOAuth::resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> ¶meters).
Строит URL для аутентификации, используя url и parameters. Эта функция излучает сигнал authorizeWithBrowser(), чтобы потребовать взаимодействие пользователя.
void QOAuth2AuthorizationCodeFlow::setAccessTokenUrl(const QUrl &accessTokenUrl)
Устанавливает URL, используемый для запроса токена доступа, в accessTokenUrl.
Примечание: Функция-сеттер для свойства accessTokenUrl.
См. также accessTokenUrl().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.1/qoauth2authorizationcodeflow.html
