Класс QOAuth2AuthorizationCodeFlow

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

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

Свойства

• accessTokenUrl : QUrl

• 6 свойств унаследовано от QAbstractOAuth2
• 4 свойства унаследовано от QAbstractOAuth
• 1 свойство унаследовано от QObject

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

Переопределённые открытые функции

• 19 открытых функций унаследовано от QAbstractOAuth2
• 20 открытых функций унаследовано от QAbstractOAuth
• 32 открытых функции унаследовано от QObject

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

• 1 открытый слот унаследовано от QAbstractOAuth
• 1 открытый слот унаследовано от QObject

Сигналы

• 8 сигналов унаследовано от QAbstractOAuth2
• 11 сигналов унаследовано от QAbstractOAuth
• 2 сигнала унаследовано от QObject

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

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

• 3 защищённых функции унаследовано от QAbstractOAuth
• 9 защищённых функций унаследовано от QObject

Дополнительные унаследованные члены

• 11 статических открытых членов унаследовано от QObject
• 1 статический защищённый член унаследовано от QAbstractOAuth

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

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

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

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

QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(QObject *parent = nullptr)

Создаёт объект QOAuth2AuthorizationCodeFlow с родительским объектом parent.

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

Создаёт объект QOAuth2AuthorizationCodeFlow с родительским объектом parent и устанавливает manager в качестве менеджера сетевого доступа.

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

Создаёт объект QOAuth2AuthorizationCodeFlow с родительским объектом parent и устанавливает manager в качестве менеджера сетевого доступа. Идентификатор клиента установлен в clientIdentifier.

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, const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr)

Создаёт объект QOAuth2AuthorizationCodeFlow с parent в качестве родительского объекта и устанавливает manager в качестве менеджера сетевого доступа. Идентификатор клиента устанавливается в clientIdentifier, URL для аутентификации — в authenticateUrl, а URL для получения токена доступа — в accessTokenUrl.

QOAuth2AuthorizationCodeFlow::~QOAuth2AuthorizationCodeFlow()

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

QUrl QOAuth2AuthorizationCodeFlow::accessTokenUrl() const

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

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

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

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

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

[override virtual slot] void QOAuth2AuthorizationCodeFlow::grant()

Переопределяет метод из QAbstractOAuth::grant().

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

[slot] void QOAuth2AuthorizationCodeFlow::refreshAccessToken()

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

См. также: Refresh Token

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

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

[override virtual protected] void QOAuth2AuthorizationCodeFlow::resourceOwnerAuthorization(const QUrl &url, const QVariantMap &parameters = QVariantMap())

Переопределяет метод из QAbstractOAuth::resourceOwnerAuthorization().

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

[override virtual] QString QOAuth2AuthorizationCodeFlow::responseType() const

Переопределяет метод из QAbstractOAuth2::responseType().

Возвращает response_type, используемый в QOAuth2AuthorizationCodeFlow; он фиксирован в "code", как требуется в The OAuth 2.0 RFC.

void QOAuth2AuthorizationCodeFlow::setAccessTokenUrl(const QUrl &accessTokenUrl)

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

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

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