#include <monitor.h>

Inheritance diagram for Akonadi::Monitor:

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	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	itemsRemoved (const Akonadi::Item::List &items)

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	resourceMonitored (const QByteArray &identifier, bool monitored)

Public Member Functions
	Monitor (QObject *parent=0)

virtual	~Monitor ()

CollectionFetchScope &	collectionFetchScope ()

Collection::List	collectionsMonitored () const

void	fetchChangedOnly (bool enable)

void	fetchCollection (bool enable)

void	fetchCollectionStatistics (bool enable)

void	ignoreSession (Session *session)

bool	isAllMonitored () const

ItemFetchScope &	itemFetchScope ()

AKONADI_DEPRECATED QList < Item::Id >	itemsMonitored () const

QVector< Item::Id >	itemsMonitoredEx () const

QStringList	mimeTypesMonitored () const

QList< QByteArray >	resourcesMonitored () const

Session *	session () const

void	setAllMonitored (bool monitored=true)

void	setCollectionFetchScope (const CollectionFetchScope &fetchScope)

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

void	setCollectionMoveTranslationEnabled (bool enabled)

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)

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 delievered 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.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Definition at line 72 of file monitor.h.

Constructor & Destructor Documentation

Monitor::Monitor ( QObject * parent = 0 )

explicit

Creates a new monitor.

Parameters

parent The parent object.

Definition at line 39 of file monitor.cpp.

Monitor::~Monitor ( )

virtual

Destroys the monitor.

Definition at line 59 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

monitored Whether 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

collection	The new collection.
parent	The 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

collection The 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

collection	The changed collection.
attributeNames	The 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 215 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

collection	The collection
monitored	Whether 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

collection	The moved collection.
source	The previous parent collection.
destination	The 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

collection The removed collection.

Akonadi::Collection::List Monitor::collectionsMonitored ( ) const

Returns the list of collections being monitored.

Since: 4.3

Definition at line 221 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

id	The collection identifier of the changed collection.
statistics	The 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

collection	The subscribed collection
parent	The 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

collection The unsubscribed collection

Since: 4.6

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

enable true to enable the feature, false means everything that was requested will be fetched.

Returns: void

Definition at line 203 of file monitor.cpp.

void Monitor::fetchCollection ( bool enable )

Enables automatic fetching of changed collections from the Akonadi storage.

Parameters

enable true enables automatic fetching, false disables automatic fetching.

Definition at line 179 of file monitor.cpp.

void Monitor::fetchCollectionStatistics ( bool enable )

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

Parameters

enable true to enables automatic fetching, false disables automatic fetching.

Definition at line 185 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

session The session you want to ignore.

Definition at line 166 of file monitor.cpp.

bool Monitor::isAllMonitored ( ) const

Returns true if everything is being monitored.

Since: 4.3

Definition at line 254 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

item	The new item.
collection	The 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

item	The changed item.
partIdentifiers	The 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 197 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

item	The linked item.
collection	The 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

item	The item
monitored	Whether 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

item	The moved item.
collectionSource	The collection the item has been moved from.
collectionDestination	The 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

item	The 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

items	Items that were changed
addedFlags	Flags that have been added to each item in `items`
removedFlags	Flags 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

items	The linked items
collection	The collections the items are linked to

Since: 4.11

QList< Item::Id > Monitor::itemsMonitored ( ) const

Returns the set of items being monitored.

Since: 4.3

Deprecated:: Use itemsMonitoredEx() instead.

Definition at line 227 of file monitor.cpp.

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 233 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

items	Moved items
collectionSource	The collection the items have been moved from.
collectionDestination	The collection the items have been moved to.

Since: 4.11

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

items Removed items

Since: 4.11

void Akonadi::Monitor::itemsUnlinked	(	const Akonadi::Item::List &	items,
		const Akonadi::Collection &	collection
	)

signal

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

Parameters

items	The unlinked items
collection	The 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

item	The unlinked item.
collection	The 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

mimeType	The mimeType.
monitored	Whether 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 242 of file monitor.cpp.

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

identifier	The identifier of the resource.
monitored	Whether 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 248 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 275 of file monitor.cpp.

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

Sets whether all items shall be monitored.

Parameters

monitored sets 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 146 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

fetchScope The new scope for collection fetch operations.

See also: collectionFetchScope()

Since: 4.4

Definition at line 209 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

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

Definition at line 66 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

enabled enables collection move translation if set as true

Since: 4.9

Definition at line 281 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

fetchScope The new scope for item fetch operations.

See also: itemFetchScope()

Definition at line 191 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

item	The item to monitor.
monitored	Whether to monitor the item.

Definition at line 86 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

mimetype	The mime type to monitor.
monitored	Whether to monitor the mime type.

Definition at line 126 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

resource	The resource identifier.
monitored	Whether to monitor the resource.

Definition at line 106 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

session the session to be set

Since: 4.4

Definition at line 260 of file monitor.cpp.

The documentation for this class was generated from the following files:

akonadi

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

akonadi

kdepimlibs API Reference

Search