Класс Ssu

(Sailfish::Mdm::Ssu)

Класс Ssu предоставляет API для управления конфигурацией SSU. Подробнее…

Заголовочный файл:

#include <mdm-ssu.h>

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

Свойства

domain : const QString
domainConfig : QVariantMap
error : const bool
isRegistered : const bool
lastError : const QString

Публичные методы

Ssu(QObject *parent = nullptr)
QString domain() const
QVariantMap domainConfig() const
bool error() const
QString getConfigValue(const QString &key) const
bool isRegistered() const
QString lastError() const
void registerDevice(const QString &user, const QString &password)
void revokeRegistration()
void setConfigValue(const QString &key, const QString &value)
void setDomainConfig(const QVariantMap &config)
bool setExtraHeaders(const QString &json)

Сигналы

void done()

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

Класс Ssu предоставляет API для управления конфигурацией SSU.

Для использования данного класса в qmake-настройки проекта клиента следует добавить следующее:

 CONFIG += link_pkgconfig
 PKGCONFIG += sailfishmdm

и затем #include <mdm-ssu.h>.

Пример использования:

 #include <mdm-ssu.h>
 void configureUpdates(const QString &host,
                       const QString &username,
                       const QString &password)
 {
     auto ssu = new Sailfish::Mdm::Ssu(this);
     ssu->setConfigValue("releaseDomain", host);
     ssu->setConfigValue("secureDomain", host);
     ssu->registerDevice(userName, password);
     QObject::connect(ssu, &Sailfish::Mdm::Ssu::done,
                      ssu {
                          if (ssu->error())
                              qWarning() << "Ошибка регистрации:" << ssu->lastError();
                          else
                              qInfo() << "Устройство зарегистрировано.";
                      });
 }

Описание свойств

domain : const QString

Свойство содержит текущий домен SSU.

Методы доступа:

QString domain() const

domainConfig : QVariantMap

Свойство содержит текущую конфигурацию домена.

Методы доступа:

QVariantMap domainConfig() const
void setDomainConfig(const QVariantMap &config)

error : const bool

Свойство остаётся истинным, если не удалось выполнить последнюю операцию.

Методы доступа:

bool error() const

isRegistered : const bool

Свойство остаётся истинным, если устройство уже зарегистрировано.

Методы доступа:

bool isRegistered() const

lastError : const QString

Свойство содержит описание последней ошибки.

Методы доступа:

QString lastError() const

Описание методов класса

Ssu::Ssu(QObject *parent = nullptr)

Создаёт новый экземпляр Ssu с заданным родителем parent.

[signal] void Ssu::done()

QString Ssu::getConfigValue(const QString &key) const

Извлекает одно значение из текущей конфигурации домена.

Эквивалентно domainConfig()[key].

void Ssu::registerDevice(const QString &user, const QString &password)

Регистрирует устройство с предоставленными учётными данными. Испускает Ssu::done() по завершении.

Проверяет Ssu::error() чтобы убедиться, что операция прошла успешно.

void Ssu::revokeRegistration()

Отменяет текущую регистрацию и стирает всю информацию об учётной записи с устройства. Испускает Ssu::done() по завершении.

Проверяет Ssu::error() чтобы убедиться, что операция прошла успешно.

void Ssu::setConfigValue(const QString &key, const QString &value)

Изменяет одно значение из текущей конфигурации домена.

Эквивалентно

 auto conf = domainConfig();
 conf[key] = value;
 setDomainConfig(conf).

void Ssu::setDomainConfig(const QVariantMap &config)

Заменяет текущую конфигурацию домена на config.

Примечание: устанавливает domainConfig.

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

bool Ssu::setExtraHeaders(const QString &json)

Устанавливает дополнительные правила заголовка для SSU. Используется для настройки авторизации. Принимает строковое представление json-файла с правилами.