Akonadi::Monitor

Akonadi::Monitor Class Reference

#include <monitor.h>

Inheritance diagram for Akonadi::Monitor:

Public Types

enum  Type {
  Collections = 1, Items, Tags, Relations,
  Subscribers, Notifications
}
 

Signals

void allMonitored (bool monitored)
 
void collectionAdded (const Akonadi::Collection &collection, const Akonadi::Collection &parent)
 
void collectionChanged (const Akonadi::Collection &collection)
 
void collectionChanged (const Akonadi::Collection &collection, const QSet< QByteArray > &attributeNames)
 
void collectionMonitored (const Akonadi::Collection &collection, bool monitored)
 
void collectionMoved (const Akonadi::Collection &collection, const Akonadi::Collection &source, const Akonadi::Collection &destination)
 
void collectionRemoved (const Akonadi::Collection &collection)
 
void collectionStatisticsChanged (Akonadi::Collection::Id id, const Akonadi::CollectionStatistics &statistics)
 
void collectionSubscribed (const Akonadi::Collection &collection, const Akonadi::Collection &parent)
 
void collectionUnsubscribed (const Akonadi::Collection &collection)
 
void debugNotification (const Akonadi::ChangeNotification &notification)
 
void itemAdded (const Akonadi::Item &item, const Akonadi::Collection &collection)
 
void itemChanged (const Akonadi::Item &item, const QSet< QByteArray > &partIdentifiers)
 
void itemLinked (const Akonadi::Item &item, const Akonadi::Collection &collection)
 
void itemMonitored (const Akonadi::Item &item, bool monitored)
 
void itemMoved (const Akonadi::Item &item, const Akonadi::Collection &collectionSource, const Akonadi::Collection &collectionDestination)
 
void itemRemoved (const Akonadi::Item &item)
 
void itemsFlagsChanged (const Akonadi::Item::List &items, const QSet< QByteArray > &addedFlags, const QSet< QByteArray > &removedFlags)
 
void itemsLinked (const Akonadi::Item::List &items, const Akonadi::Collection &collection)
 
void itemsMoved (const Akonadi::Item::List &items, const Akonadi::Collection &collectionSource, const Akonadi::Collection &collectionDestination)
 
void itemsRelationsChanged (const Akonadi::Item::List &items, const Akonadi::Relation::List &addedRelations, const Akonadi::Relation::List &removedRelations)
 
void itemsRemoved (const Akonadi::Item::List &items)
 
void itemsTagsChanged (const Akonadi::Item::List &items, const QSet< Akonadi::Tag > &addedTags, const QSet< Akonadi::Tag > &removedTags)
 
void itemsUnlinked (const Akonadi::Item::List &items, const Akonadi::Collection &collection)
 
void itemUnlinked (const Akonadi::Item &item, const Akonadi::Collection &collection)
 
void mimeTypeMonitored (const QString &mimeType, bool monitored)
 
void monitorReady ()
 
void notificationSubscriberAdded (const Akonadi::NotificationSubscriber &subscriber)
 
void notificationSubscriberChanged (const Akonadi::NotificationSubscriber &subscriber)
 
void notificationSubscriberRemoved (const Akonadi::NotificationSubscriber &subscriber)
 
void relationAdded (const Akonadi::Relation &relation)
 
void relationRemoved (const Akonadi::Relation &relation)
 
void resourceMonitored (const QByteArray &identifier, bool monitored)
 
void tagAdded (const Akonadi::Tag &tag)
 
void tagChanged (const Akonadi::Tag &tag)
 
void tagMonitored (const Akonadi::Tag &tag, bool monitored)
 
void tagRemoved (const Akonadi::Tag &tag)
 
void typeMonitored (const Akonadi::Monitor::Type type, bool monitored)
 

Public Member Functions

 Monitor (QObject *parent=nullptr)
 
 ~Monitor () override
 
CollectionFetchScopecollectionFetchScope ()
 
Collection::List collectionsMonitored () const
 
bool exclusive () const
 
void fetchChangedOnly (bool enable)
 
void fetchCollection (bool enable)
 
void fetchCollectionStatistics (bool enable)
 
void ignoreSession (Session *session)
 
bool isAllMonitored () const
 
ItemFetchScopeitemFetchScope ()
 
QVector< Item::Id > itemsMonitoredEx () const
 
QStringList mimeTypesMonitored () const
 
int numItemsMonitored () const
 
int numMimeTypesMonitored () const
 
int numResourcesMonitored () const
 
QList< QByteArrayresourcesMonitored () const
 
Sessionsession () const
 
void setAllMonitored (bool monitored=true)
 
void setCollectionFetchScope (const CollectionFetchScope &fetchScope)
 
void setCollectionMonitored (const Collection &collection, bool monitored=true)
 
void setCollectionMoveTranslationEnabled (bool enabled)
 
void setExclusive (bool exclusive=true)
 
void setItemFetchScope (const ItemFetchScope &fetchScope)
 
void setItemMonitored (const Item &item, bool monitored=true)
 
void setMimeTypeMonitored (const QString &mimetype, bool monitored=true)
 
void setResourceMonitored (const QByteArray &resource, bool monitored=true)
 
void setSession (Akonadi::Session *session)
 
void setTagFetchScope (const TagFetchScope &fetchScope)
 
void setTagMonitored (const Tag &tag, bool monitored=true)
 
void setTypeMonitored (Type type, bool monitored=true)
 
TagFetchScopetagFetchScope ()
 
QVector< Tag::Id > tagsMonitored () const
 
QVector< TypetypesMonitored () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Monitors an item or collection for changes.

The Monitor emits signals if some of these objects are changed or removed or new ones are added to the Akonadi storage.

There are various ways to filter these notifications. There are three types of filter evaluation:

  • (-) removal-only filter, ie. if the filter matches the notification is dropped, if not filter evaluation continues with the next one
  • (+) pass-exit filter, ie. if the filter matches the notification is delivered, if not evaluation is continued
  • (f) final filter, ie. evaluation ends here if the corresponding filter criteria is set, the notification is delivered depending on the result, evaluation is only continued if no filter criteria is defined

The following filter are available, listed in evaluation order: (1) ignored sessions (-) (2) monitor everything (+) (3a) resource and mimetype filters (f) (items only) (3b) resource filters (f) (collections only) (4) item is monitored (+) (5) collection is monitored (+)

Optionally, the changed objects can be fetched automatically from the server. To enable this, see itemFetchScope() and collectionFetchScope().

Note that as a consequence of rule 3a, it is not possible to monitor (more than zero resources OR more than zero mimetypes) AND more than zero collections.

Todo:

Distinguish between monitoring collection properties and collection content.

Special case for collection content counts changed

Author
Volker Krause vkrau[email protected][email protected][email protected]de.or[email protected]g

Definition at line 71 of file monitor.h.

Member Enumeration Documentation

Enumerator
Collections 

This must be kept in sync with Akonadi::NotificationMessageV2::Type

Subscribers 

Listen to subscription changes of other Monitors connected to Akonadi.

This is only for debugging purposes and should not be used in real applications.

Since
5.4
Notifications 

Listens to all notifications being emitted by the server and provides additional information about them.

This is only for debugging purposes and should not be used in real applications.

Note
Enabling monitoring this type has performance impact on the Akonadi Server.
Since
5.4

Definition at line 76 of file monitor.h.

Constructor & Destructor Documentation

Monitor::Monitor ( QObject parent = nullptr)
explicit

Creates a new monitor.

Parameters
parentThe parent object.

Definition at line 22 of file monitor.cpp.

Monitor::~Monitor ( )
override

Destroys the monitor.

Definition at line 44 of file monitor.cpp.

Member Function Documentation

void Akonadi::Monitor::allMonitored ( bool  monitored)
signal

This signal is emitted if the Monitor starts or stops monitoring everything.

Parameters
monitoredWhether everything is now being monitored or not.
Since
4.3
void Akonadi::Monitor::collectionAdded ( const Akonadi::Collection collection,
const Akonadi::Collection parent 
)
signal

This signal is emitted if a new collection has been added to a monitored collection in the Akonadi storage.

Parameters
collectionThe new collection.
parentThe parent collection.
void Akonadi::Monitor::collectionChanged ( const Akonadi::Collection collection)
signal

This signal is emitted if a monitored collection has been changed (properties or content).

Parameters
collectionThe changed collection.
void Akonadi::Monitor::collectionChanged ( const Akonadi::Collection collection,
const QSet< QByteArray > &  attributeNames 
)
signal

This signal is emitted if a monitored collection has been changed (properties or attributes).

Parameters
collectionThe changed collection.
attributeNamesThe names of the collection attributes that have been changed.
Since
4.4
CollectionFetchScope & Monitor::collectionFetchScope ( )

Returns the collection fetch scope.

Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable. See the CollectionFetchScope documentation for an example.

Returns
a reference to the current collection fetch scope
See also
setCollectionFetchScope() for replacing the current collection fetch scope
Since
4.4

Definition at line 237 of file monitor.cpp.

void Akonadi::Monitor::collectionMonitored ( const Akonadi::Collection collection,
bool  monitored 
)
signal

This signal is emitted if the Monitor starts or stops monitoring collection explicitly.

Parameters
collectionThe collection
monitoredWhether the collection is now being monitored or not.
Since
4.3
void Akonadi::Monitor::collectionMoved ( const Akonadi::Collection collection,
const Akonadi::Collection source,
const Akonadi::Collection destination 
)
signal

This signals is emitted if a monitored collection has been moved.

Parameters
collectionThe moved collection.
sourceThe previous parent collection.
destinationThe new parent collection.
Since
4.4
void Akonadi::Monitor::collectionRemoved ( const Akonadi::Collection collection)
signal

This signal is emitted if a monitored collection has been removed from the Akonadi storage.

Parameters
collectionThe removed collection.
Akonadi::Collection::List Monitor::collectionsMonitored ( ) const

Returns the list of collections being monitored.

Since
4.3

Definition at line 261 of file monitor.cpp.

void Akonadi::Monitor::collectionStatisticsChanged ( Akonadi::Collection::Id  id,
const Akonadi::CollectionStatistics statistics 
)
signal

This signal is emitted if the statistics information of a monitored collection has changed.

Parameters
idThe collection identifier of the changed collection.
statisticsThe updated collection statistics, invalid if automatic fetching of statistics changes is disabled.
void Akonadi::Monitor::collectionSubscribed ( const Akonadi::Collection collection,
const Akonadi::Collection parent 
)
signal

This signal is emitted if a collection has been subscribed to by the user.

It will be emitted even for unmonitored collections as the check for whether to monitor it has not been applied yet.

Parameters
collectionThe subscribed collection
parentThe parent collection of the subscribed collection.
Since
4.6
void Akonadi::Monitor::collectionUnsubscribed ( const Akonadi::Collection collection)
signal

This signal is emitted if a user unsubscribes from a collection.

Parameters
collectionThe unsubscribed collection
Since
4.6
void Akonadi::Monitor::debugNotification ( const Akonadi::ChangeNotification &  notification)
signal

This signal is emitted when Notifications are monitored and the server emits any change notification.

Since
5.4
Note
Getting introspection into all change notifications only makes sense if you want to globally debug Notifications. There is no reason to use this in regular applications.
void Monitor::fetchChangedOnly ( bool  enable)

Instructs the monitor to fetch only those parts that were changed and were requested in the fetch scope.

This is taken in account only for item modifications. Example usage:

monitor->itemFetchScope().fetchFullPayload( true );
monitor->fetchChangedOnly(true);

In the example if an item was changed, but its payload was not, the full payload will not be retrieved. If the item's payload was changed, the monitor retrieves the changed payload as well.

The default is to fetch everything requested.

Since
4.8
Parameters
enabletrue to enable the feature, false means everything that was requested will be fetched.

Definition at line 223 of file monitor.cpp.

void Monitor::fetchCollection ( bool  enable)

Enables automatic fetching of changed collections from the Akonadi storage.

Parameters
enabletrue enables automatic fetching, false disables automatic fetching.

Definition at line 195 of file monitor.cpp.

void Monitor::fetchCollectionStatistics ( bool  enable)

Enables automatic fetching of changed collection statistics information from the Akonadi storage.

Parameters
enabletrue to enables automatic fetching, false disables automatic fetching.

Definition at line 201 of file monitor.cpp.

void Monitor::ignoreSession ( Session session)

Ignores all change notifications caused by the given session.

This overrides all other settings on this session.

Parameters
sessionThe session you want to ignore.

Definition at line 183 of file monitor.cpp.

bool Monitor::isAllMonitored ( ) const

Returns true if everything is being monitored.

Since
4.3

Definition at line 324 of file monitor.cpp.

void Akonadi::Monitor::itemAdded ( const Akonadi::Item &  item,
const Akonadi::Collection collection 
)
signal

This signal is emitted if an item has been added to a monitored collection in the Akonadi storage.

Parameters
itemThe new item.
collectionThe collection the item has been added to.
void Akonadi::Monitor::itemChanged ( const Akonadi::Item &  item,
const QSet< QByteArray > &  partIdentifiers 
)
signal

This signal is emitted if a monitored item has changed, e.g.

item parts have been modified.

Parameters
itemThe changed item.
partIdentifiersThe identifiers of the item parts that has been changed.
ItemFetchScope & Monitor::itemFetchScope ( )

Returns the item fetch scope.

Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable. See the ItemFetchScope documentation for an example.

Returns
a reference to the current item fetch scope
See also
setItemFetchScope() for replacing the current item fetch scope

Definition at line 215 of file monitor.cpp.

void Akonadi::Monitor::itemLinked ( const Akonadi::Item &  item,
const Akonadi::Collection collection 
)
signal

This signal is emitted if a reference to an item is added to a virtual collection.

Parameters
itemThe linked item.
collectionThe collection the item is linked to.
Since
4.2
void Akonadi::Monitor::itemMonitored ( const Akonadi::Item &  item,
bool  monitored 
)
signal

This signal is emitted if the Monitor starts or stops monitoring item explicitly.

Parameters
itemThe item
monitoredWhether the item is now being monitored or not.
Since
4.3
void Akonadi::Monitor::itemMoved ( const Akonadi::Item &  item,
const Akonadi::Collection collectionSource,
const Akonadi::Collection collectionDestination 
)
signal

This signal is emitted if a monitored item has been moved between two collections.

Parameters
itemThe moved item.
collectionSourceThe collection the item has been moved from.
collectionDestinationThe collection the item has been moved to.
void Akonadi::Monitor::itemRemoved ( const Akonadi::Item &  item)
signal

This signal is emitted if.

  • a monitored item has been removed from the Akonadi storage or
  • a item has been removed from a monitored collection.
Parameters
itemThe removed item.
void Akonadi::Monitor::itemsFlagsChanged ( const Akonadi::Item::List &  items,
const QSet< QByteArray > &  addedFlags,
const QSet< QByteArray > &  removedFlags 
)
signal

This signal is emitted if flags of monitored items have changed.

Parameters
itemsItems that were changed
addedFlagsFlags that have been added to each item in items
removedFlagsFlags that have been removed from each item in items
Since
4.11
void Akonadi::Monitor::itemsLinked ( const Akonadi::Item::List &  items,
const Akonadi::Collection collection 
)
signal

This signal is emitted if a reference to multiple items is added to a virtual collection.

Parameters
itemsThe linked items
collectionThe collections the items are linked to
Since
4.11
QVector< Item::Id > Monitor::itemsMonitoredEx ( ) const

Returns the set of items being monitored.

Faster version (at least on 32-bit systems) of itemsMonitored().

Since
4.6

Definition at line 267 of file monitor.cpp.

void Akonadi::Monitor::itemsMoved ( const Akonadi::Item::List &  items,
const Akonadi::Collection collectionSource,
const Akonadi::Collection collectionDestination 
)
signal

This is signal is emitted when multiple monitored items have been moved between two collections.

Parameters
itemsMoved items
collectionSourceThe collection the items have been moved from.
collectionDestinationThe collection the items have been moved to.
Since
4.11
void Akonadi::Monitor::itemsRelationsChanged ( const Akonadi::Item::List &  items,
const Akonadi::Relation::List addedRelations,
const Akonadi::Relation::List removedRelations 
)
signal

This signal is emitted if relations of monitored items have changed.

Parameters
itemsItems that were changed
addedRelationsRelations that have been added to each item in items.
removedRelationsRelations that have been removed from each item in items
Since
4.15
void Akonadi::Monitor::itemsRemoved ( const Akonadi::Item::List &  items)
signal

This signal is emitted if monitored items have been removed from Akonadi storage of items have been removed from a monitored collection.

Parameters
itemsRemoved items
Since
4.11
void Akonadi::Monitor::itemsTagsChanged ( const Akonadi::Item::List &  items,
const QSet< Akonadi::Tag > &  addedTags,
const QSet< Akonadi::Tag > &  removedTags 
)
signal

This signal is emitted if tags of monitored items have changed.

Parameters
itemsItems that were changed
addedTagsTags that have been added to each item in items.
removedTagsTags that have been removed from each item in items
Since
4.13
void Akonadi::Monitor::itemsUnlinked ( const Akonadi::Item::List &  items,
const Akonadi::Collection collection 
)
signal

This signal is emitted if a reference to items is removed from a virtual collection.

Parameters
itemsThe unlinked items
collectionThe collections the items are unlinked from
Since
4.11
void Akonadi::Monitor::itemUnlinked ( const Akonadi::Item &  item,
const Akonadi::Collection collection 
)
signal

This signal is emitted if a reference to an item is removed from a virtual collection.

Parameters
itemThe unlinked item.
collectionThe collection the item is unlinked from.
Since
4.2
void Akonadi::Monitor::mimeTypeMonitored ( const QString mimeType,
bool  monitored 
)
signal

This signal is emitted if the Monitor starts or stops monitoring mimeType explicitly.

Parameters
mimeTypeThe mimeType.
monitoredWhether the mimeType is now being monitored or not.
Since
4.3
QStringList Monitor::mimeTypesMonitored ( ) const

Returns the set of mimetypes being monitored.

Since
4.3

Definition at line 300 of file monitor.cpp.

void Akonadi::Monitor::notificationSubscriberAdded ( const Akonadi::NotificationSubscriber &  subscriber)
signal

This signal is emitted when Subscribers are monitored and a new subscriber subscribers to the server.

Parameters
subscriberThe new subscriber
Since
5.4
Note
Monitoring for subscribers and listening to this signal only makes sense if you want to globally debug Monitors. There is no reason to use this in regular applications.
void Akonadi::Monitor::notificationSubscriberChanged ( const Akonadi::NotificationSubscriber &  subscriber)
signal

This signal is emitted when Subscribers are monitored and an existing subscriber changes its subscription.

Parameters
subscriberThe changed subscriber
Since
5.4
Note
Monitoring for subscribers and listening to this signal only makes sense if you want to globally debug Monitors. There is no reason to use this in regular applications.
void Akonadi::Monitor::notificationSubscriberRemoved ( const Akonadi::NotificationSubscriber &  subscriber)
signal

This signal is emitted when Subscribers are monitored and an existing subscriber unsubscribes from the server.

Parameters
subscriberThe removed subscriber
Since
5.4
Note
Monitoring for subscribers and listening to this signal only makes sense if you want to globally debug Monitors. There is no reason to use this in regular applications.
int Monitor::numItemsMonitored ( ) const

Returns the number of items being monitored.

Optimization.

Since
4.14.3

Definition at line 276 of file monitor.cpp.

int Monitor::numMimeTypesMonitored ( ) const

Returns the number of mimetypes being monitored.

Optimization.

Since
4.14.3

Definition at line 306 of file monitor.cpp.

int Monitor::numResourcesMonitored ( ) const

Returns the number of resources being monitored.

Optimization.

Since
4.14.3

Definition at line 318 of file monitor.cpp.

void Akonadi::Monitor::relationAdded ( const Akonadi::Relation relation)
signal

This signal is emitted if a relation has been added to Akonadi storage.

The monitor will also emit itemRelationsChanged() signal for all monitored items hat are affected by relation.

Parameters
relationThe added relation
Since
4.13
void Akonadi::Monitor::relationRemoved ( const Akonadi::Relation relation)
signal

This signal is emitted if a monitored relation is removed from the server storage.

The monitor will also emit itemRelationsChanged() signal for all monitored items that were affected by relation.

Parameters
relationThe removed relation.
Since
4.13
void Akonadi::Monitor::resourceMonitored ( const QByteArray identifier,
bool  monitored 
)
signal

This signal is emitted if the Monitor starts or stops monitoring the resource with the identifier identifier explicitly.

Parameters
identifierThe identifier of the resource.
monitoredWhether the resource is now being monitored or not.
Since
4.3
QList< QByteArray > Monitor::resourcesMonitored ( ) const

Returns the set of identifiers for resources being monitored.

Since
4.3

Definition at line 312 of file monitor.cpp.

Session * Monitor::session ( ) const

Returns the Session used by the monitor to communicate with Akonadi.

Since
4.4

Definition at line 351 of file monitor.cpp.

void Akonadi::Monitor::setAllMonitored ( bool  monitored = true)

Sets whether all items shall be monitored.

Parameters
monitoredsets all items as monitored if set as true Note that if a session is being ignored, this takes precedence over setAllMonitored() on that session.

Definition at line 154 of file monitor.cpp.

void Monitor::setCollectionFetchScope ( const CollectionFetchScope fetchScope)

Sets the collection fetch scope.

Controls which collections are monitored and how much of a collection's data is fetched from the server.

Parameters
fetchScopeThe new scope for collection fetch operations.
See also
collectionFetchScope()
Since
4.4

Definition at line 229 of file monitor.cpp.

void Monitor::setCollectionMonitored ( const Collection collection,
bool  monitored = true 
)

Sets whether the specified collection shall be monitored for changes.

If monitoring is turned on for the collection, all notifications for items in that collection will be emitted, and its child collections will also be monitored. Note that move notifications will be emitted if either one of the collections involved is being monitored.

Note that if a session is being ignored, this takes precedence over setCollectionMonitored() on that session.

Parameters
collectionThe collection to monitor. If this collection is Collection::root(), all collections in the Akonadi storage will be monitored.
monitoredWhether to monitor the collection.

Definition at line 51 of file monitor.cpp.

void Monitor::setCollectionMoveTranslationEnabled ( bool  enabled)

Allows to enable/disable collection move translation.

If enabled (the default), move notifications are automatically translated into add/remove notifications if the source/destination is outside of the monitored collection hierarchy.

Parameters
enabledenables collection move translation if set as true
Since
4.9

Definition at line 357 of file monitor.cpp.

void Monitor::setItemFetchScope ( const ItemFetchScope fetchScope)

Sets the item fetch scope.

Controls how much of an item's data is fetched from the server, e.g. whether to fetch the full item payload or only meta data.

Parameters
fetchScopeThe new scope for item fetch operations.
See also
itemFetchScope()

Definition at line 207 of file monitor.cpp.

void Monitor::setItemMonitored ( const Item &  item,
bool  monitored = true 
)

Sets whether the specified item shall be monitored for changes.

Note that if a session is being ignored, this takes precedence over setItemMonitored() on that session.

Parameters
itemThe item to monitor.
monitoredWhether to monitor the item.

Definition at line 68 of file monitor.cpp.

void Monitor::setMimeTypeMonitored ( const QString mimetype,
bool  monitored = true 
)

Sets whether items of the specified mime type shall be monitored for changes.

If monitoring is turned on for the mime type, all notifications for items matching that mime type will be emitted, but notifications for collections matching that mime type will only be emitted if this is otherwise specified, for example by setCollectionMonitored().

Note that if a session is being ignored, this takes precedence over setMimeTypeMonitored() on that session.

Parameters
mimetypeThe mime type to monitor.
monitoredWhether to monitor the mime type.

Definition at line 102 of file monitor.cpp.

void Monitor::setResourceMonitored ( const QByteArray resource,
bool  monitored = true 
)

Sets whether the specified resource shall be monitored for changes.

If monitoring is turned on for the resource, all notifications for collections and items in that resource will be emitted.

Note that if a session is being ignored, this takes precedence over setResourceMonitored() on that session.

Parameters
resourceThe resource identifier.
monitoredWhether to monitor the resource.

Definition at line 85 of file monitor.cpp.

void Monitor::setSession ( Akonadi::Session session)

Sets the session used by the Monitor to communicate with the Akonadi server.

If not set, the Akonadi::Session::defaultSession is used.

Parameters
sessionthe session to be set
Since
4.4

Definition at line 330 of file monitor.cpp.

void Monitor::setTagFetchScope ( const TagFetchScope fetchScope)

Sets the tag fetch scope.

Controls how much of an tag's data is fetched from the server.

Parameters
fetchScopeThe new scope for tag fetch operations.
See also
tagFetchScope()

Definition at line 245 of file monitor.cpp.

void Monitor::setTagMonitored ( const Tag tag,
bool  monitored = true 
)

Sets whether the specified tag shall be monitored for changes.

Same rules as for item monitoring apply.

Parameters
tagTag to monitor.
monitoredWhether to monitor the tag.
Since
4.13

Definition at line 119 of file monitor.cpp.

void Monitor::setTypeMonitored ( Monitor::Type  type,
bool  monitored = true 
)

Sets whether given type (Collection, Item, Tag should be monitored).

By default all types are monitored, but once you change one, you have to explicitly enable all other types you want to monitor.

Parameters
typeType to monitor.
monitoredWhether to monitor the type
Since
4.13

Definition at line 136 of file monitor.cpp.

void Akonadi::Monitor::tagAdded ( const Akonadi::Tag tag)
signal

This signal is emitted if a tag has been added to Akonadi storage.

Parameters
tagThe added tag
Since
4.13
void Akonadi::Monitor::tagChanged ( const Akonadi::Tag tag)
signal

This signal is emitted if a monitored tag is changed on the server.

Parameters
tagThe changed tag.
Since
4.13
TagFetchScope & Monitor::tagFetchScope ( )

Returns the tag fetch scope.

Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable.

Returns
a reference to the current tag fetch scope
See also
setTagFetchScope() for replacing the current tag fetch scope

Definition at line 253 of file monitor.cpp.

void Akonadi::Monitor::tagMonitored ( const Akonadi::Tag tag,
bool  monitored 
)
signal

This signal is emitted if the Monitor starts or stops monitoring tag explicitly.

Parameters
tagThe tag.
monitoredWhether the tag is now being monitored or not.
Since
4.13
void Akonadi::Monitor::tagRemoved ( const Akonadi::Tag tag)
signal

This signal is emitted if a monitored tag is removed from the server storage.

The monitor will also emit itemTagsChanged() signal for all monitored items (if any) that were tagged by tag.

Parameters
tagThe removed tag.
Since
4.13
QVector< Tag::Id > Monitor::tagsMonitored ( ) const

Returns the set of tags being monitored.

Since
4.13

Definition at line 282 of file monitor.cpp.

void Akonadi::Monitor::typeMonitored ( const Akonadi::Monitor::Type  type,
bool  monitored 
)
signal

This signal is emitted if the Monitor starts or stops monitoring type explicitly.

Parameters
typeThe type.
monitoredWhether the type is now being monitored or not.
Since
4.13
QVector< Monitor::Type > Monitor::typesMonitored ( ) const

Returns the set of types being monitored.

Since
4.13

Definition at line 291 of file monitor.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Nov 29 2020 23:16:34 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.