Класс Client
(Aurora::PushNotifications::Client)
Клиент для системы push-уведомлений. Подробнее…
| Подключение: | #include <push_client.h> |
Свойства
- applicationId : const QString
Публичные функции
| Client(QObject *parent = nullptr) | |
| virtual | ~Client() |
| QString | applicationId() const |
| int | error() |
| QString | errorMessage() |
| bool | isPushSystemReady() |
| void | registrate() |
| void | setApplicationId(const QString &applicationId) |
Сигналы
| void | clientInactive() |
| void | notifications(const Aurora::PushNotifications::PushList &pushList) |
| void | pushSystemReadinessChanged(bool isReady) |
| void | registrationError() |
| void | registrationId(const QString ®istrationId) |
Подробное описание
Клиент для системы push-уведомлений.
Класс предоставляет средства для работы с системой push-уведомлений Aurora.
Описание свойств
applicationId : const QString
Функции доступа:
| QString | applicationId() const |
Описание функций-членов
Client::Client(QObject *parent = nullptr)
Создаёт объект Client с заданным родителем parent.
[virtual] Client::~Client()
Уничтожает объект Client. Деструктор является виртуальным.
QString Client::applicationId() const
Возвращает идентификатор приложения.
Примечание — Функция возвращает значение свойства applicationId.
См. также setApplicationId.
[signal] void Client::clientInactive()
Отправляется, если в течение 60 секунд не выполнялось никаких действий, связанных с push-уведомлениями.
int Client::error()
Получение последнего кода ошибки регистрации.
| Код | Значение |
|---|---|
| 0 | Нет ошибок |
| 1 | Приложение с заданным идентификатором не найдено на сервере |
| 5 | Проект Push неактивен или уведомления были отключены для этого приложения |
| 6 | Внутренняя ошибка |
См. также errorMessage.
QString Client::errorMessage()
Получение последнего сообщения ошибки регистрации.
См. также error.
bool Client::isPushSystemReady()
Возвращает true, если система push-уведомлений полностью функционирует и может обрабатывать
запросы приложения, в противном случае возвращает false.
См. также pushSystemReadinessChanged.
[signal] void Client::notifications(const Aurora::PushNotifications::PushList &pushList)
Отправляется с входящим pushList, когда для приложения доступны новые push-уведомления.
[signal] void Client::pushSystemReadinessChanged(bool isReady)
Сигнал испускается, когда меняется готовность системы push-уведомлений. isReady показывает полностью ли функционирует система push-уведомлений.
См. также isPushSystemReady.
void Client::registrate()
Отправляет запрос на регистрацию на push-сервер.
См. также registrationId и registrationError.
[signal] void Client::registrationError()
Сигнал испускается в случае ошибки во время регистрации.
См. также error и errorMessage.
[signal] void Client::registrationId(const QString ®istrationId)
Сигнал испускается, когда был обработан ответ на запрос регистрации. Содержит registrationId, созданный для приложения на сервере. В случае ошибки registrationId будет пустым.
void Client::setApplicationId(const QString &applicationId)
Устанавливает applicationId. Идентификатор должен быть указан в начале работы с клиентом.
См. также applicationId.