#include <collection.h>

Inheritance diagram for Akonadi::Collection:

Public Types
typedef QList< Collection >	List

enum	ListPreference { ListEnabled, ListDisabled, ListDefault }

enum	ListPurpose { ListSync, ListDisplay, ListIndex }

enum	Right { ReadOnly = 0x0, CanChangeItem = 0x1, CanCreateItem = 0x2, CanDeleteItem = 0x4, CanChangeCollection = 0x8, CanCreateCollection = 0x10, CanDeleteCollection = 0x20, CanLinkItem = 0x40, CanUnlinkItem = 0x80, AllRights }

enum	UrlType { UrlShort = 0, UrlWithName = 1 }

Public Types inherited from Akonadi::Entity
enum	CreateOption { AddIfMissing }

typedef qint64	Id

Public Member Functions
	Collection ()

	Collection (Id id)

	Collection (const Collection &other)

	~Collection ()

CachePolicy	cachePolicy () const

QStringList	contentMimeTypes () const

QString	displayName () const

bool	enabled () const

bool	isVirtual () const

ListPreference	localListPreference (ListPurpose purpose) const

QString	name () const

AKONADI_DEPRECATED Id	parent () const

AKONADI_DEPRECATED QString	parentRemoteId () const

bool	referenced () const

QString	resource () const

Rights	rights () const

void	setCachePolicy (const CachePolicy &policy)

void	setContentMimeTypes (const QStringList &types)

void	setEnabled (bool enabled)

void	setLocalListPreference (ListPurpose purpose, ListPreference preference)

void	setName (const QString &name)

AKONADI_DEPRECATED void	setParent (Id parent)

AKONADI_DEPRECATED void	setParent (const Collection &collection)

AKONADI_DEPRECATED void	setParentRemoteId (const QString &identifier)

void	setReferenced (bool referenced)

void	setResource (const QString &identifier)

void	setRights (Rights rights)

void	setShouldList (ListPurpose purpose, bool shouldList)

void	setStatistics (const CollectionStatistics &statistics)

void	setVirtual (bool isVirtual)

bool	shouldList (ListPurpose purpose) const

CollectionStatistics	statistics () const

KUrl	url () const

KUrl	url (UrlType type) const

Public Member Functions inherited from Akonadi::Entity
void	addAttribute (Attribute *attribute)

Attribute *	attribute (const QByteArray &name) const

template<typename T >
T *	attribute (CreateOption option)

template<typename T >
T *	attribute () const

Attribute::List	attributes () const

void	clearAttributes ()

bool	hasAttribute (const QByteArray &name) const

template<typename T >
bool	hasAttribute () const

Id	id () const

bool	isValid () const

bool	operator!= (const Entity &other) const

bool	operator< (const Entity &other) const

Entity &	operator= (const Entity &other)

bool	operator== (const Entity &other) const

Collection	parentCollection () const

Collection &	parentCollection ()

QString	remoteId () const

QString	remoteRevision () const

void	removeAttribute (const QByteArray &name)

template<typename T >
void	removeAttribute ()

void	setId (Id identifier)

void	setParentCollection (const Collection &parent)

void	setRemoteId (const QString &id)

void	setRemoteRevision (const QString &revision)

Static Public Member Functions
static Collection	fromUrl (const KUrl &url)

static QString	mimeType ()

static Collection	root ()

static QString	virtualMimeType ()

Additional Inherited Members
Protected Member Functions inherited from Akonadi::Entity
	Entity (const Entity &other)

	~Entity ()

Detailed Description

Represents a collection of PIM items.

This class represents a collection of PIM items, such as a folder on a mail- or groupware-server.

Collections are hierarchical, i.e., they may have a parent collection.

using namespace Akonadi;
// fetching all collections recursive, starting at the root collection
CollectionFetchJob *job = new CollectionFetchJob( Collection::root(), CollectionFetchJob::Recursive );
connect( job, SIGNAL(result(KJob*)), SLOT(fetchFinished(KJob*)) );
...
MyClass::fetchFinished( KJob *job )
{
  if ( job->error() ) {
    qDebug() << "Error occurred";
    return;
  }
  CollectionFetchJob *fetchJob = qobject_cast<CollectionFetchJob*>( job );
  const Collection::List collections = fetchJob->collections();
  foreach ( const Collection &collection, collections ) {
    qDebug() << "Name:" << collection.name();
  }
}

Author: Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Definition at line 75 of file collection.h.

Member Typedef Documentation

typedef QList<Collection> Akonadi::Collection::List

Describes a list of collections.

Definition at line 81 of file collection.h.

Member Enumeration Documentation

enum Akonadi::Collection::ListPreference

Describes the list preference value.

Since: 4.14

Enumerator
ListEnabled	Enable collection for specified purpose.
ListDisabled	Disable collectoin for specified purpose.
ListDefault	Fallback to enabled state.

Definition at line 324 of file collection.h.

enum Akonadi::Collection::ListPurpose

Describes the purpose of the listing.

Since: 4.14

Enumerator
ListSync	Listing for synchronization.
ListDisplay	Listing for display to the user.
ListIndex	Listing for indexing the content.

Definition at line 335 of file collection.h.

enum Akonadi::Collection::Right

Describes rights of a collection.

Enumerator
ReadOnly	Can only read items or subcollection of this collection.
CanChangeItem	Can change items in this collection.
CanCreateItem	Can create new items in this collection.
CanDeleteItem	Can delete items in this collection.
CanChangeCollection	Can change this collection.
CanCreateCollection	Can create new subcollections in this collection.
CanDeleteCollection	Can delete this collection.
CanLinkItem	Can create links to existing items in this virtual collection. Since 4.4
CanUnlinkItem	Can remove links to items in this virtual collection. Since 4.4
AllRights	Has all rights on this storage collection.

Definition at line 86 of file collection.h.

enum Akonadi::Collection::UrlType

Describes the type of url which is returned in url().

Since: 4.7

Enumerator
UrlShort	A short url which contains the identifier only (equivalent to url())
UrlWithName	A url with identifier and name.

Definition at line 264 of file collection.h.

Constructor & Destructor Documentation

Collection::Collection ( )

Creates an invalid collection.

Definition at line 59 of file collection.cpp.

Collection::Collection ( Id id )

explicit

Create a new collection.

Parameters

id	The unique identifier of the collection.

Definition at line 67 of file collection.cpp.

Collection::~Collection ( )

Destroys the collection.

Definition at line 77 of file collection.cpp.

Collection::Collection ( const Collection & other )

Creates a collection from an other collection.

Definition at line 72 of file collection.cpp.

Member Function Documentation

CachePolicy Collection::cachePolicy ( ) const

Returns the cache policy of the collection.

Definition at line 249 of file collection.cpp.

QStringList Collection::contentMimeTypes ( ) const

Returns a list of possible content mimetypes, e.g.

message/rfc822, x-akonadi/collection for a mail folder that supports sub-folders.

Definition at line 115 of file collection.cpp.

QString Collection::displayName ( ) const

Returns the display name (EntityDisplayAttribute::displayName()) if set, and Collection::name() otherwise.

For human-readable strings this is preferred over Collection::name().

Since: 4.11

Definition at line 86 of file collection.cpp.

bool Collection::enabled ( ) const

Returns the collection's enabled state.

Since: 4.14

See also: localListPreference

Definition at line 281 of file collection.cpp.

Collection Collection::fromUrl ( const KUrl & url )

static

Creates a collection from the given url.

Definition at line 172 of file collection.cpp.

bool Collection::isVirtual ( ) const

Returns whether the collection is virtual, for example a search collection.

Since: 4.6

Definition at line 261 of file collection.cpp.

Collection::ListPreference Collection::localListPreference ( Collection::ListPurpose purpose ) const

Returns the local list preference for the specified purpose.

Since: 4.14

See also: setLocalListPreference

Definition at line 306 of file collection.cpp.

QString Collection::mimeType ( )

static

Returns the mimetype used for collections.

Definition at line 197 of file collection.cpp.

QString Collection::name ( ) const

Returns the i18n'ed name of the collection.

Definition at line 81 of file collection.cpp.

Collection::Id Collection::parent ( ) const

Returns the identifier of the parent collection.

Deprecated:: Use parentCollection()

Definition at line 129 of file collection.cpp.

QString Collection::parentRemoteId ( ) const

Returns the parent remote identifier.

Note: This usually returns nothing for collections retrieved from the backend.

Deprecated:: Use parentCollection()

Definition at line 144 of file collection.cpp.

bool Collection::referenced ( ) const

Returns the referenced state of the collection.

Since: 4.14

Definition at line 346 of file collection.cpp.

QString Collection::resource ( ) const

Returns the identifier of the resource owning the collection.

Definition at line 207 of file collection.cpp.

Collection::Rights Collection::rights ( ) const

Returns the rights the user has on the collection.

Definition at line 99 of file collection.cpp.

Collection Collection::root ( )

static

Returns the root collection.

Definition at line 192 of file collection.cpp.

void Collection::setCachePolicy ( const CachePolicy & policy )

Sets the cache policy of the collection.

Definition at line 254 of file collection.cpp.

void Collection::setContentMimeTypes ( const QStringList & types )

Sets the list of possible content mime types.

Definition at line 120 of file collection.cpp.

void Collection::setEnabled ( bool enabled )

Sets the collection's enabled state.

Use this mechanism to set if a collection should be available to the user or not.

This can be used in conjunction with the local list preference for finer grained control to define if a collection should be included depending on the purpose.

For example: A collection is by default enabled, meaning it is displayed to the user, synchronized by the resource, and indexed by the indexer. A disabled collection on the other hand is not displayed, sychronized or indexed. The local list preference allows to locally override that default value for each purpose individually.

The enabled state can be synchronized by backends. E.g. an imap resource may synchronize this with the subscription state.

Since: 4.14

See also: setLocalListPreference, setShouldList

Definition at line 273 of file collection.cpp.

void Collection::setLocalListPreference	(	Collection::ListPurpose	purpose,
		Collection::ListPreference	preference
	)

Sets the local list preference for the specified purpose.

The local list preference overrides the enabled state unless set to ListDefault. In case of ListDefault the enabled state should be taken as fallback (shouldList() implements this logic).

The default value is ListDefault.

Since: 4.14

See also: shouldList, setEnabled

Definition at line 288 of file collection.cpp.

void Collection::setName ( const QString & name )

Sets the i18n'ed name of the collection.

Parameters

name	The new collection name.

Definition at line 93 of file collection.cpp.

void Collection::setParent ( Id parent )

Sets the identifier of the parent collection.

Parameters

parent the parent identifier to set

Deprecated:: Use setParentCollection()

Definition at line 134 of file collection.cpp.

void Collection::setParent ( const Collection & collection )

Sets the parent collection.

Parameters

collection the parent collection to set

Deprecated:: Use setParentCollection()

Definition at line 139 of file collection.cpp.

void Collection::setParentRemoteId ( const QString & identifier )

Sets the parent's remote identifier.

Parameters

identifier the parent's remote identifier to set

Deprecated:: Use setParentCollection()

Definition at line 149 of file collection.cpp.

void Collection::setReferenced ( bool referenced )

Sets a collection to be referenced.

A referenced collection is temporarily shown and synchronized even when disabled. A reference is only valid for the duration of a session, and is automatically removed afterwards.

Referenced collections are only visible if explicitly monitored in the ETM.

Since: 4.14

Definition at line 338 of file collection.cpp.

void Collection::setResource ( const QString & identifier )

Sets the identifier of the resource owning the collection.

Definition at line 212 of file collection.cpp.

void Collection::setRights ( Rights rights )

Sets the rights the user has on the collection.

Definition at line 109 of file collection.cpp.

void Collection::setShouldList	(	ListPurpose	purpose,
		bool	shouldList
	)

Sets wether the collection should be listed or not for the specified purpose.

Takes enabled state and local preference into account.

Use this instead of sestEnabled and setLocalListPreference to automatically set the right setting.

Since: 4.14

See also: setLocalListPreference, setEnabled

Definition at line 329 of file collection.cpp.

void Collection::setStatistics ( const CollectionStatistics & statistics )

Sets the collection statistics for the collection.

Definition at line 243 of file collection.cpp.

void Akonadi::Collection::setVirtual ( bool isVirtual )

Sets whether the collection is virtual or not.

Virtual collections can't be converted to non-virtual and vice versa.

Parameters

isVirtual virtual collection if true, otherwise a normal collection

Since: 4.10

Definition at line 266 of file collection.cpp.

bool Collection::shouldList ( Collection::ListPurpose purpose ) const

Returns whether the collection should be listed or not for the specified purpose Takes enabled state and local preference into account.

Since: 4.14

See also: setLocalListPreference, setEnabled

Definition at line 321 of file collection.cpp.

CollectionStatistics Collection::statistics ( ) const

Returns the collection statistics of the collection.

Definition at line 238 of file collection.cpp.

KUrl Collection::url ( ) const

Returns the url of the collection.

Todo:: KDE5 remove in favor of url( UrlType type = UrlShort ).

Definition at line 154 of file collection.cpp.

KUrl Collection::url ( UrlType type ) const

Returns the url of the collection.

Parameters

type	the type of url

Since: 4.7

Definition at line 159 of file collection.cpp.

QString Akonadi::Collection::virtualMimeType ( )

static

Returns the mimetype used for virtual collections.

Since: 4.11

Definition at line 202 of file collection.cpp.

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

akonadi

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

akonadi

kdepimlibs API Reference

Search