Класс QAbstractOAuth2
Класс QAbstractOAuth2 является основой всех реализаций методов аутентификации OAuth 2. Подробнее...
| Заголовок: | #include <QAbstractOAuth2> |
| qmake: | QT += networkauth |
| С момента: | Qt 5.8 |
| Наследует: | QAbstractOAuth |
| Наследуется от: |
Свойства
|
- 4 свойства, унаследованные от QAbstractOAuth
- 1 свойство, унаследованное от QObject
Открытые функции
| QAbstractOAuth2(QObject *parent = nullptr) | |
| QAbstractOAuth2(QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| ~QAbstractOAuth2() | |
| QString | clientIdentifierSharedKey() const |
| virtual QUrl | createAuthenticatedUrl(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) |
| QDateTime | expirationAt() const |
| virtual QString | responseType() const = 0 |
| QString | scope() const |
| void | setClientIdentifierSharedKey(const QString &clientIdentifierSharedKey) |
| void | setScope(const QString &scope) |
| void | setState(const QString &state) |
| void | setUserAgent(const QString &userAgent) |
| QString | state() const |
| QString | userAgent() const |
Переопределённые открытые функции
| virtual QString | clientIdentifier() const override |
| virtual QNetworkReply * | deleteResource(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
| virtual QNetworkReply * | get(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
| virtual QNetworkReply * | head(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
| virtual QNetworkReply * | post(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
| virtual void | setClientIdentifier(const QString &clientIdentifier) override |
| virtual void | setToken(const QString &token) override |
| virtual QString | token() const override |
- 20 открытых функций, унаследованных от QAbstractOAuth
- 32 открытых функции, унаследованные от QObject
Сигналы
| void | authorizationCallbackReceived(const QVariantMap &data) |
| void | clientIdentifierChanged(const QString &clientIdentifier) |
| void | clientIdentifierSharedKeyChanged(const QString &clientIdentifierSharedKey) |
| void | error(const QString &error, const QString &errorDescription, const QUrl &uri) |
| void | expirationAtChanged(const QDateTime &expiration) |
| void | scopeChanged(const QString &scope) |
| void | stateChanged(const QString &state) |
| void | userAgentChanged(const QString &userAgent) |
- 11 сигналов, унаследованных от QAbstractOAuth
- 2 сигнала, унаследованных от QObject
Защищённые функции
| QAbstractOAuth2(QAbstractOAuth2Private &, QObject *parent = nullptr) |
- 3 защищённые функции, унаследованные от QAbstractOAuth
- 9 защищённых функций, унаследованных от QObject
Дополнительные унаследованные члены
- 1 открытый слот, унаследованный от QAbstractOAuth
- 1 открытый слот, унаследованный от QObject
- 11 статических открытых членов, унаследованных от QObject
- 1 статический защищённый член, унаследованный от QAbstractOAuth
Подробное описание
Класс QAbstractOAuth2 является основой всех реализаций методов аутентификации OAuth 2.
Класс определяет базовый интерфейс классов аутентификации OAuth 2. Наследуя этот класс, вы можете создавать собственные методы аутентификации, используя стандарт OAuth 2 для различных веб-сервисов.
Описание работы OAuth 2 можно найти в: The OAuth 2.0 Authorization Framework
Документация свойств
clientIdentifier : QString
Это свойство содержит идентификатор клиента, используемый для идентификации приложения в процессе аутентификации.
Функции доступа:
| virtual QString | clientIdentifier() const override |
| virtual void | setClientIdentifier(const QString &clientIdentifier) override |
Сигнал уведомления:
| void | clientIdentifierChanged(const QString &clientIdentifier) |
clientIdentifierSharedKey : QString
Это свойство содержит общий ключ клиента, используемый в качестве пароля, если сервер требует аутентификации для запроса токена.
Функции доступа:
| QString | clientIdentifierSharedKey() const |
| void | setClientIdentifierSharedKey(const QString &clientIdentifierSharedKey) |
Сигнал уведомления:
| void | clientIdentifierSharedKeyChanged(const QString &clientIdentifierSharedKey) |
expiration : const QDateTime
Это свойство содержит время истечения срока действия текущего токена доступа.
Функции доступа:
| QDateTime | expirationAt() const |
Сигнал уведомления:
| void | expirationAtChanged(const QDateTime &expiration) |
scope : QString
Это свойство содержит желаемый scope, который определяет разрешения, запрашиваемые клиентом.
Функции доступа:
| QString | scope() const |
| void | setScope(const QString &scope) |
Сигнал уведомления:
| void | scopeChanged(const QString &scope) |
state : QString
Это свойство содержит строку, отправленную на сервер во время аутентификации. State используется для идентификации и проверки запроса при получении обратного вызова.
Функции доступа:
| QString | state() const |
| void | setState(const QString &state) |
Сигнал уведомления:
| void | stateChanged(const QString &state) |
userAgent : QString
Это свойство содержит заголовок User-Agent, используемый для создания сетевых запросов.
Значение по умолчанию — "QtOAuth/1.0 (+https://www.qt.io)".
Функции доступа:
| QString | userAgent() const |
| void | setUserAgent(const QString &userAgent) |
Сигнал уведомления:
| void | userAgentChanged(const QString &userAgent) |
Документация по функциям членов
QAbstractOAuth2::QAbstractOAuth2(QObject *parent = nullptr)
Создаёт объект QAbstractOAuth2, используя parent в качестве родительского объекта.
QAbstractOAuth2::QAbstractOAuth2(QNetworkAccessManager *manager, QObject *parent = nullptr)
Создаёт объект QAbstractOAuth2, используя parent в качестве родительского объекта и устанавливает manager в качестве менеджера сетевого доступа.
[protected] QAbstractOAuth2::QAbstractOAuth2(QAbstractOAuth2Private &, QObject *parent = nullptr)
Конструктор копирования.
QAbstractOAuth2::~QAbstractOAuth2()
Удаляет экземпляр QAbstractOAuth2.
[signal] void QAbstractOAuth2::authorizationCallbackReceived(const QVariantMap &data)
Сигнал, излучаемый, когда сервер ответа получает обратный вызов аутентификации от сервера: data содержит значения, полученные от сервера.
[virtual] QUrl QAbstractOAuth2::createAuthenticatedUrl(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Возвращаемый URL основан на url, объединяя его с заданными parameters и токеном доступа.
[override virtual] QNetworkReply *QAbstractOAuth2::deleteResource(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Переопределено из QAbstractOAuth::deleteResource().
Отправляет аутентифицированный запрос DELETE и возвращает новый QNetworkReply. url и parameters используются для создания запроса.
См. также: Hypertext Transfer Protocol -- HTTP/1.1: DELETE
[signal] void QAbstractOAuth2::error(const QString &error, const QString &errorDescription, const QUrl &uri)
Сигнал, излучаемый, когда сервер отвечает на запрос с ошибкой: error — имя ошибки; errorDescription описывает ошибку, а uri — необязательный URI, содержащий дополнительную информацию об ошибке.
[override virtual] QNetworkReply *QAbstractOAuth2::get(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Переопределено из QAbstractOAuth::get().
Отправляет аутентифицированный запрос GET и возвращает новый QNetworkReply. url и parameters используются для создания запроса.
См. также: Hypertext Transfer Protocol -- HTTP/1.1: GET
[override virtual] QNetworkReply *QAbstractOAuth2::head(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Переопределено из QAbstractOAuth::head().
Отправляет аутентифицированный запрос HEAD и возвращает новый QNetworkReply. url и parameters используются для создания запроса.
См. также: Hypertext Transfer Protocol -- HTTP/1.1: HEAD
[override virtual] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Переопределено из QAbstractOAuth::post().
Отправляет аутентифицированный запрос POST и возвращает новый QNetworkReply. url и parameters используются для создания запроса.
См. также: Hypertext Transfer Protocol -- HTTP/1.1: POST
[pure virtual] QString QAbstractOAuth2::responseType() const
[override virtual] void QAbstractOAuth2::setToken(const QString &token)
См. также token().
[override virtual] QString QAbstractOAuth2::token() const
См. также setToken().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qabstractoauth2.html
