Spec-Zone.ru › Qt 5.11

Класс 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 в настоящее время не поддерживает входные или исходящие параметры. В 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.11/qauthenticator.html

Spec-Zone.ru

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