Класс QAbstractOAuth

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

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

Типы public

Свойства

• authorizationUrl : QUrl
• contentType : QAbstractOAuth::ContentType
• extraTokens : const QVariantMap
• status : const Status

Функции public

Свойства public

Сигналы

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

Статические защищенные члены

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

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

Он также содержит некоторые функции, чтобы упростить процесс реализации различных потоков аутентификации.

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

Перечисление QAbstractOAuth::ContentType

Указывает MIME Content-Type методов POST в аутентифицированных вызовах.

перечисление QAbstractOAuth::Ошибка

Указывает последнюю полученную ошибку.

перечисление QAbstractOAuth::Этап

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

перечисление QAbstractOAuth::Статус

Указывает текущий статус аутентификации.

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

[signal] void QAbstractOAuth::авторизоватьСБраузером(const QUrl &url)

Этот сигнал генерируется, когда url, сгенерированная функцией resourceOwnerAuthorization(), готова к использованию в веб-браузере для предоставления приложению возможности действовать от имени пользователя.

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

[pure virtual slot] void QAbstractOAuth::предоставить()

Переопределите эту функцию, чтобы реализовать соответствующий поток аутентификации в подклассах. Код клиента вызывает эту функцию для запуска процесса аутентификации. Это может потребовать взаимодействия с пользователем: например, запросить разрешение пользователя через веб-браузер. При успешной аутентификации должен быть отправлен сигнал granted; это уведомление о том, что учетные данные готовы к использованию в аутентифицированных вызовах.

[signal] void QAbstractOAuth::предоставлено()

Этот сигнал генерируется, когда поток авторизации завершен успешно.

[virtual] QAbstractOAuth::~QAbstractOAuth()

Уничтожает абстрактный OAuth.

QUrl QAbstractOAuth::authorizationUrl() const

Возвращает URL запроса авторизации.

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

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

[protected] QString QAbstractOAuth::callback() const

Возвращает текущую строку callback, соответствующую текущему обработчику ответа. Возвращаемая строка — это строка, отправляемая на сервер для указания callback URI или слово, идентифицирующее альтернативный метод в бессерверных устройствах.

См. также replyHandler() и setReplyHandler().

QString QAbstractOAuth::clientIdentifier() const

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

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

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

QAbstractOAuth::ТипСодержимого QAbstractOAuth::contentType() const

Возвращает текущий Content-Type, используемый в аутентифицированных вызовах.

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

См. также setContentType() и post().

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

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

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

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

QVariantMap QAbstractOAuth::extraTokens() const

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

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

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

[static protected] QByteArray QAbstractOAuth::generateRandomString(quint8 length)

Генерирует случайную строку, которая может быть использована в качестве состояния или nonce. Параметр length определяет размер сгенерированной строки.

См. также: The OAuth 1.0 Protocol: Nonce and Timestamp.

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

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

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

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

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

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

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

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

QAbstractOAuth::ModifyParametersFunction QAbstractOAuth::modifyParametersFunction() const

Возвращает текущую функцию модификации параметров.

См. также setModifyParametersFunction() и Stage.

QNetworkAccessManager *QAbstractOAuth::networkAccessManager() const

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

См. также setNetworkAccessManager() и QNetworkAccessManager.

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

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

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

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

[pure virtual, since 5.13] void QAbstractOAuth::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray())

Авторизует данный запрос request, добавив в него заголовок и тело, необходимые для аутентифицированных запросов.

verb должен быть допустимым HTTP-глаголом и таким же, как будет использован для отправки request.

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

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

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

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

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

QAbstractOAuthReplyHandler *QAbstractOAuth::replyHandler() const

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

См. также setReplyHandler() и QAbstractOAuthReplyHandler.

[virtual protected] void QAbstractOAuth::resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> &parameters)

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

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

void QAbstractOAuth::setAuthorizationUrl(const QUrl &url)

Устанавливает URL запроса авторизации на url. Этот адрес будет использован, чтобы разрешить пользователю предоставить приложению возможность выполнять аутентифицированные вызовы от имени пользователя.

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

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

void QAbstractOAuth::setClientIdentifier(const QString &clientIdentifier)

Устанавливает текущий идентификатор клиента на clientIdentifier.

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

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

void QAbstractOAuth::setContentType(QAbstractOAuth::ContentType contentType)

Устанавливает текущий Content-Type на contentType.

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

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

void QAbstractOAuth::setModifyParametersFunction(const QAbstractOAuth::ModifyParametersFunction &modifyParametersFunction)

Устанавливает функцию модификации параметров modifyParametersFunction. Эта функция используется для настройки параметров, отправляемых на сервер на определённой стадии авторизации. Количество вызовов этой функции зависит от используемого потока авторизации.

См. также modifyParametersFunction() и Stage.

void QAbstractOAuth::setNetworkAccessManager(QNetworkAccessManager *networkAccessManager)

Устанавливает менеджер сети на networkAccessManager. QAbstractOAuth не принимает владение networkAccessManager. Если не установлен пользовательский менеджер сетевого доступа, используется внутренний менеджер. Этот менеджер будет использоваться для отправки запроса на сервер аутентификации и аутентифицированного запроса к веб-сервису.

См. также networkAccessManager() и QNetworkAccessManager.

void QAbstractOAuth::setReplyHandler(QAbstractOAuthReplyHandler *handler)

Устанавливает текущий обработчик ответов на handler.

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

[protected] void QAbstractOAuth::setStatus(QAbstractOAuth::Status status)

Устанавливает текущий статус на status. Этот метод предназначен для использования классами, основанными на QAbstractOAuth.

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

void QAbstractOAuth::setToken(const QString &token)

Устанавливает токен, используемый для подписи аутентифицированных запросов, в token.

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

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

QAbstractOAuth::Status QAbstractOAuth::status() const

Возвращает текущий статус аутентификации.

Примечание: Метод-геттер для свойства status.

См. также setStatus() и Status.

QString QAbstractOAuth::token() const

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

Примечание: Метод-геттер для свойства token.

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