Класс QAbstractOAuth2

Класс QAbstractOAuth2 является базой всех реализаций методов аутентификации OAuth 2. Подробнее...

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

Свойства

Общедоступные функции

Реализованные публичные функции

Сигналы

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

Класс определяет базовый интерфейс классов аутентификации OAuth 2. Наследуя этот класс, вы можете создавать собственные методы аутентификации, используя стандарт OAuth 2 для различных веб-сервисов.

Описание работы OAuth 2 можно найти здесь: The OAuth 2.0 Authorization Framework

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

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

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

QAbstractOAuth2::QAbstractOAuth2(QObject *parent = nullptr)

Создаёт объект QAbstractOAuth2, используя parent в качестве родительского объекта.

[signal] void QAbstractOAuth2::authorizationCallbackReceived(const QVariantMap &data)

Сигнал, испускаемый, когда сервер ответа получает обратный вызов авторизации от сервера: data содержит значения, полученные от сервера.

[signal] void QAbstractOAuth2::error(const QString &error, const QString &errorDescription, const QUrl &uri)

Сигнал, испускаемый, когда сервер отвечает на запрос с ошибкой: error — имя ошибки; errorDescription описывает ошибку, а uri — необязательный URI, содержащий дополнительную информацию об ошибке.

[virtual] QAbstractOAuth2::~QAbstractOAuth2()

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

[virtual invokable] QUrl QAbstractOAuth2::createAuthenticatedUrl(const QUrl &url, const QVariantMap &parameters = QVariantMap())

Возвращаемый URL основан на url, объединяя его с заданными parameters и токеном доступа.

Примечание: Эту функцию можно вызывать через метаобъектную систему и из QML. См. Q_INVOKABLE.

[override virtual invokable] QNetworkReply *QAbstractOAuth2::deleteResource(const QUrl &url, const QVariantMap &parameters = QVariantMap())

Реализация QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap &parameters).

Отправляет аутентифицированный запрос DELETE и возвращает новый QNetworkReply. url и parameters используются для создания запроса.

См. также: Hypertext Transfer Protocol -- HTTP/1.1: DELETE

Примечание: Эту функцию можно вызывать через метаобъектную систему и из QML. См. Q_INVOKABLE.

[override virtual invokable] QNetworkReply *QAbstractOAuth2::get(const QUrl &url, const QVariantMap &parameters = QVariantMap())

Реализация QAbstractOAuth::get(const QUrl &url, const QVariantMap &parameters).

Отправляет аутентифицированный запрос GET и возвращает новый QNetworkReply. url и parameters используются для создания запроса.

См. также: Hypertext Transfer Protocol -- HTTP/1.1: GET

Примечание: Эту функцию можно вызывать через метаобъектную систему и из QML. См. Q_INVOKABLE.

[override virtual invokable] QNetworkReply *QAbstractOAuth2::head(const QUrl &url, const QVariantMap &parameters = QVariantMap())

Реализация QAbstractOAuth::head(const QUrl &url, const QVariantMap &parameters).

Отправляет аутентифицированный запрос HEAD и возвращает новый QNetworkReply. url и parameters используются для создания запроса.

См. также: Hypertext Transfer Protocol -- HTTP/1.1: HEAD

Примечание: Эту функцию можно вызывать через метаобъектную систему и из QML. См. Q_INVOKABLE.

[override virtual invokable] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QVariantMap &parameters = QVariantMap())

Реализация QAbstractOAuth::post(const QUrl &url, const QVariantMap &parameters).

Отправляет аутентифицированный запрос POST и возвращает новый QNetworkReply. url и parameters используются для создания запроса.

См. также: Hypertext Transfer Protocol -- HTTP/1.1: POST

Примечание: Эту функцию можно вызывать через метаобъектную систему и из QML. См. Q_INVOKABLE.

[virtual invokable, since 5.10] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, const QByteArray &data)

Это перегруженная функция.

Отправляет аутентифицированный запрос POST и возвращает новый QNetworkReply. url и data используются для создания запроса.

{Hypertext Transfer Protocol -- HTTP/1.1: POST}

Примечание: Эту функцию можно вызывать через метаобъектную систему и из QML. См. Q_INVOKABLE.

Функция была добавлена в Qt 5.10.

См. также post() и https://tools.ietf.org/html/rfc2616#section-9.6.

[virtual invokable, since 5.10] QNetworkReply *QAbstractOAuth2::post(const QUrl &url, QHttpMultiPart *multiPart)

Это перегруженный метод.

Отправляет аутентифицированный запрос POST и возвращает новый QNetworkReply. Для создания запроса используются url и multiPart.

{Протокол передачи гипертекста — HTTP/1.1: POST}

Примечание: Этот метод можно вызвать через метаобъектную систему и из QML. См. Q_INVOKABLE.

Этот метод был добавлен в Qt 5.10.

См. также post(), QHttpMultiPart и https://tools.ietf.org/html/rfc2616#section-9.6.

[override virtual] void QAbstractOAuth2::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray())

Переопределяет: QAbstractOAuth::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body).

[override virtual invokable] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, const QVariantMap &parameters = QVariantMap())

Переопределяет: QAbstractOAuth::put(const QUrl &url, const QVariantMap &parameters).

Отправляет аутентифицированный запрос PUT и возвращает новый QNetworkReply. Для создания запроса используются url и parameters.

См. также: Протокол передачи гипертекста — HTTP/1.1: PUT

Примечание: Этот метод можно вызвать через метаобъектную систему и из QML. См. Q_INVOKABLE.

[virtual invokable, since 5.10] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, const QByteArray &data)

Это перегруженный метод.

Отправляет аутентифицированный запрос PUT и возвращает новый QNetworkReply. Для создания запроса используются url и data.

{Протокол передачи гипертекста — HTTP/1.1: PUT}

Примечание: Этот метод можно вызвать через метаобъектную систему и из QML. См. Q_INVOKABLE.

Этот метод был добавлен в Qt 5.10.

См. также put() и https://tools.ietf.org/html/rfc2616#section-9.6.

[virtual invokable, since 5.10] QNetworkReply *QAbstractOAuth2::put(const QUrl &url, QHttpMultiPart *multiPart)

Это перегруженный метод.

Отправляет аутентифицированный запрос PUT и возвращает новый QNetworkReply. Для создания запроса используются url и multiPart.

{Протокол передачи гипертекста — HTTP/1.1: PUT}

Примечание: Этот метод можно вызвать через метаобъектную систему и из QML. См. Q_INVOKABLE.

Этот метод был добавлен в Qt 5.10.

См. также put(), QHttpMultiPart и https://tools.ietf.org/html/rfc2616#section-9.6.

QString QAbstractOAuth2::refreshToken() const

Получает текущий токен обновления.

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

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

Примечание: Метод-получатель для свойства refreshToken.

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

QString QAbstractOAuth2::responseType() const

Возвращает используемый response_type.

void QAbstractOAuth2::setRefreshToken(const QString &refreshToken)

Устанавливает новый токен обновления refreshToken для использования.

Пользовательский токен обновления может использоваться для обновления токена доступа с помощью этого метода, а затем токен доступа может быть обновлён с помощью QOAuth2AuthorizationCodeFlow::refreshAccessToken().

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

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