Класс QOAuth2AuthorizationCodeFlow

Класс QOAuth2AuthorizationCodeFlow предоставляет реализацию потока Authorization Code Grant. Подробнее...

• Список всех членов, включая наследуемые

Свойства

• accessTokenUrl : QUrl

Открытые функции

Открытые слоты

Сигналы

Защищенные функции

Переопределенные защищенные функции

Подробное описание

Этот класс реализует поток Authorization Code Grant, который используется как для получения, так и для обновления токенов доступа. Это поток, основанный на перенаправлении, поэтому пользователю потребуется доступ к веб-браузеру.

Документация по функциям-членам

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

Запускает поток аутентификации, как описано в The OAuth 2.0 Authorization Framework

[slot] void QOAuth2AuthorizationCodeFlow::refreshAccessToken()

Вызовите эту функцию для обновления токена. Токены доступа не являются постоянными. По истечении срока действия, указанного вместе с токеном доступа при его получении, токен доступа станет недействительным.

См. также: Refresh Token

[virtual] QOAuth2AuthorizationCodeFlow::~QOAuth2AuthorizationCodeFlow()

Уничтожает экземпляр класса QOAuth2AuthorizationCodeFlow.

QUrl QOAuth2AuthorizationCodeFlow::accessTokenUrl() const

Возвращает URL, используемый для запроса токена доступа.

Примечание: Функция-получатель для свойства accessTokenUrl.

См. также setAccessTokenUrl().

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

Генерирует URL для аутентификации, используемый в Запросе авторизации с использованием parameters.

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

Запрашивает токен доступа по полученному code. code получен в ответ, когда пользователь успешно завершил аутентификацию в браузере.

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

Переопределяет: QAbstractOAuth::resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> &parameters).

Строит URL для аутентификации, используя url и parameters. Эта функция излучает сигнал authorizeWithBrowser(), чтобы потребовать взаимодействие пользователя.

void QOAuth2AuthorizationCodeFlow::setAccessTokenUrl(const QUrl &accessTokenUrl)

Устанавливает URL, используемый для запроса токена доступа, в accessTokenUrl.

Примечание: Функция-сеттер для свойства accessTokenUrl.

См. также accessTokenUrl().