KPeople::AllContactsMonitor Class
This class should be subclassed by each datasource and return a list of all contacts that the datasource knows about. More...
| Header: | #include <KPeopleBackend/AllContactsMonitor> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS PeopleBackend)target_link_libraries(mytarget PRIVATE KF6::PeopleBackend) |
| Since: | 5.8 |
Public Functions
| AllContactsMonitor() | |
| virtual QMap<QString, KPeople::AbstractContact::Ptr> | contacts() |
| bool | initialFetchSuccess() const |
| bool | isInitialFetchComplete() const |
Signals
| void | contactAdded(const QString &contactUri, const KPeople::AbstractContact::Ptr &contact) |
| void | contactChanged(const QString &contactUri, const KPeople::AbstractContact::Ptr &contact) |
| void | contactRemoved(const QString &contactUri) |
| void | initialFetchComplete(bool success) |
Protected Slots
| void | emitInitialFetchComplete(bool success) |
Detailed Description
Subclasses are expected to be asynchronous
Member Function Documentation
[explicit] AllContactsMonitor::AllContactsMonitor()
[signal] void AllContactsMonitor::contactAdded(const QString &contactUri, const KPeople::AbstractContact::Ptr &contact)
DataSources should emit this whenever a contact is added
[signal] void AllContactsMonitor::contactChanged(const QString &contactUri, const KPeople::AbstractContact::Ptr &contact)
DataSources should emit this whenever a known contact changes
[signal] void AllContactsMonitor::contactRemoved(const QString &contactUri)
DataSources should emit this whenever a contact is removed and they are no longer able to supply up-to-date data on a contact
[virtual] QMap<QString, KPeople::AbstractContact::Ptr> AllContactsMonitor::contacts()
Returns all currently loaded contacts
[protected slot] void AllContactsMonitor::emitInitialFetchComplete(bool success)
DataSources should call this once they have finished initial retrieval of all contacts from their storage.
This will emit initialFetchComplete() signal
success Whether the fetch was successful.
[signal] void AllContactsMonitor::initialFetchComplete(bool success)
Notifies that the DataSource has completed it's initial fetch.
Warning: DataSources should use emitInitialFetchComplete() instead of emitting this signal directly.
success True when the fetch was successful, False when an error occurred.