Класс ContactsManager
(Aurora::Contacts::ContactsManager)
Предоставляет данные о контактах. Подробнее…
| Подключение: | #include <contactsManager.h> |
Публичные типы
| enum | ErrorCode { NO_ERROR, CONTACT_DOESNT_EXIST, CONNECTION_ERROR, QUERY_ERROR, OTHER } |
Публичные функции
| ContactsManager(QObject *parent = nullptr) | |
| virtual | ~ContactsManager() |
| void | queryAllContacts() |
| void | queryContact(int id) |
| void | queryContactsDbVersion() |
Сигналы
| void | allContactsAvailable(QList<Contact> &contacts) |
| void | contactAvailable(Contact &contact) |
| void | contactsAdded(QList<Contact> &contacts) |
| void | contactsChanged(QList<Contact> &contacts) |
| void | contactsDbVersionChanged(uint version) |
| void | contactsRemoved(QList<Contact> &contacts) |
| void | error(ErrorCode errorCode) |
Подробное описание
Предоставляет данные о контактах.
Этот класс предназначен для асинхронного получения списка контактов, информации о конкретном контакте и версии базы данных контактов.
Он содержит сигналы об изменениях в списке контактов: добавление/удаление/изменение. А также сигнал об изменении выбранного контакта.
См. также Aurora::Contacts::Contact.
Описание типов-членов
enum ContactsManager::ErrorCode
Возможные ошибки при обращении к ContactsManager:
| Константа | Значение | Описание |
Aurora::Contacts::ContactsManager::NO_ERROR |
0 |
Указывает на отсутствие ошибок. |
Aurora::Contacts::ContactsManager::CONTACT_DOESNT_EXIST |
1 |
Указывает, что запрашиваемый контакт не найден. |
Aurora::Contacts::ContactsManager::CONNECTION_ERROR |
2 |
Указывает на сбой при установлении соединения с ContactsManager. |
Aurora::Contacts::ContactsManager::QUERY_ERROR |
3 |
Указывает на ошибку, возникшую при обработке запроса к ContactsManager. |
Aurora::Contacts::ContactsManager::OTHER |
4 |
Охватывает все ошибки, которые не попадают в данные категории. |
Описание функций-членов
ContactsManager::ContactsManager(QObject *parent = nullptr)
Создает экземпляр ContactsManager.
[virtual] ContactsManager::~ContactsManager()
Уничтожает экземпляр ContactsManager. Деструктор является виртуальным.
[signal] void ContactsManager::allContactsAvailable(QList<Contact> &contacts)
Сигнализирует о готовности списка ContactsManager::queryAllContacts, запрошенного ранее.
[signal] void ContactsManager::contactAvailable(Contact &contact)
Сигнализирует о готовности контакта ContactsManager::queryContact, запрошенного ранее.
[signal] void ContactsManager::contactsAdded(QList<Contact> &contacts)
Сигнализирует о добавлении новых контактов в телефонную книгу.
[signal] void ContactsManager::contactsChanged(QList<Contact> &contacts)
Сигнализирует об изменении информации о контактах в телефонной книге.
[signal] void ContactsManager::contactsDbVersionChanged(uint version)
Сигнализирует об изменении версии базы данных контактов.
[signal] void ContactsManager::contactsRemoved(QList<Contact> &contacts)
Сигнализирует о том, что контакты были удалены из телефонной книги.
[signal] void ContactsManager::error(ErrorCode errorCode)
Сигнализирует об ошибке, произошедшей при попытке запросить информацию о контактах из ContactsManager.
void ContactsManager::queryAllContacts()
Эта функция запрашивает все доступные контакты из ContactsManager. Запрос выполняется асинхронно, чтобы получить список контактов, необходимо использовать сигнал ContactsManager::allContactsAvailable.
void ContactsManager::queryContact(int id)
Эта функция запрашивает доступный контакт по id из ContactsManager. Запрос выполняется асинхронно, чтобы получить запрошенный контакт, необходимо использовать сигнал ContactsManager::contactAvailable.
void ContactsManager::queryContactsDbVersion()
Эта функция запрашивает версию базы данных контактов. Запрос выполняется асинхронно, чтобы получить запрошенную версию базы данных контактов, необходимо использовать сигнал ContactsManager::contactsDbVersionChanged. Это может быть полезно, чтобы не делать дополнительных запросов к ContactsManager, если версия базы данных не изменилась.