Spec-Zone.ru › Qt 5.6

Класс QAuthenticator

Класс QAuthenticator предоставляет объект аутентификации. Подробнее...

Заголовок: #include <QAuthenticator>
qmake: QT += network
С момента: Qt 4.3
  • Список всех членов, включая наследуемые

Примечание: Все функции в этом классе являются реентерабельными.

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

QAuthenticator()
QAuthenticator(const QAuthenticator &other)
~QAuthenticator()
bool isNull() const
QVariant option(const QString &opt) const
QVariantHash options() const
QString password() const
QString realm() const
void setOption(const QString &opt, const QVariant &value)
void setPassword(const QString &password)
void setUser(const QString &user)
QString user() const
bool operator!=(const QAuthenticator &other) const
QAuthenticator & operator=(const QAuthenticator &other)
bool operator==(const QAuthenticator &other) const

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

Класс QAuthenticator предоставляет объект аутентификации.

Класс QAuthenticator обычно используется в сигналах authenticationRequired() и proxyAuthenticationRequired() класса QNetworkAccessManager и QAbstractSocket. Этот класс предоставляет способ возвращения необходимой информации об аутентификации сокету при доступе к сервисам, требующим аутентификацию.

Класс QAuthenticator поддерживает следующие методы аутентификации:

  • Basic
  • NTLM версии 2
  • Digest-MD5

Параметры

Помимо имени пользователя и пароля, необходимых для аутентификации, объект QAuthenticator также может содержать дополнительные параметры. Функция options() используется для запроса входящих параметров, отправленных сервером; функция setOption() используется для установки исходящих параметров, которые будут обработаны механизмом аутентификации. Принимаемые и предоставляемые параметры зависят от типа аутентификации (см. метод()).

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

Basic

Параметр Направление Тип Описание
realm Входящий QString Содержит область аутентификации, такая же, как realm()

Механизм аутентификации Basic не поддерживает исходящих параметров.

NTLM версии 2

Механизм аутентификации NTLM версии 2 в настоящее время не поддерживает входящие или исходящие параметры. В Windows, если не задан user, будут проверяться учетные данные домена\пользователя на локальной системе для включения функции Single Sign-On.

Digest-MD5

Параметр Направление Тип Описание
realm Входящий QString Содержит область аутентификации, такая же, как realm()

Механизм аутентификации Digest-MD5 не поддерживает исходящих параметров.

См. также QSslSocket.

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

QAuthenticator::QAuthenticator()

Создает пустой объект аутентификации.

QAuthenticator::QAuthenticator(const QAuthenticator &other)

Создает копию other.

QAuthenticator::~QAuthenticator()

Удаляет объект.

bool QAuthenticator::isNull() const

Возвращает true если объект не был инициализирован. Возвращает false если были вызваны неконстантные функции-члены или содержимое было создано или скопировано из другого инициализированного объекта QAuthenticator.

QVariant QAuthenticator::option(const QString &opt) const

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

Эта функция была добавлена в Qt 4.7.

См. также setOption(), options() и Параметры QAuthenticator.

QVariantHash QAuthenticator::options() const

Возвращает все входящие параметры, установленные в этом объекте QAuthenticator после анализа ответа сервера. Подробнее о входящих параметрах см. раздел Параметры.

Эта функция была добавлена в Qt 4.7.

См. также option() и Параметры QAuthenticator.

QString QAuthenticator::password() const

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

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

QString QAuthenticator::realm() const

Возвращает область, требующую аутентификации.

void QAuthenticator::setOption(const QString &opt, const QVariant &value)

Устанавливает исходящий параметр opt со значением value. Подробнее об исходящих параметрах см. раздел Параметры.

Эта функция была добавлена в Qt 4.7.

См. также options(), option() и Параметры QAuthenticator.

void QAuthenticator::setPassword(const QString &password)

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

См. также password() и QNetworkAccessManager::authenticationRequired().

void QAuthenticator::setUser(const QString &user)

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

См. также user() и QNetworkAccessManager::authenticationRequired().

QString QAuthenticator::user() const

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

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

bool QAuthenticator::operator!=(const QAuthenticator &other) const

Возвращает true если этот объект аутентификации отличается от other; в противном случае возвращает false.

QAuthenticator &QAuthenticator::operator=(const QAuthenticator &other)

Присваивает содержимое other этому аутентификатору.

bool QAuthenticator::operator==(const QAuthenticator &other) const

Возвращает true , если этот аутентификатор идентичен other; в противном случае возвращает false.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/archives/qt-5.6/qauthenticator.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API