akonadi
Akonadi::Collection Class Reference
Represents a collection of PIM items. More...
#include <collection.h>

Public Types | |
typedef QList< Collection > | List |
enum | Right { ReadOnly = 0x0, CanChangeItem = 0x1, CanCreateItem = 0x2, CanDeleteItem = 0x4, CanChangeCollection = 0x8, CanCreateCollection = 0x10, CanDeleteCollection = 0x20, CanLinkItem = 0x40, CanUnlinkItem = 0x80, AllRights } |
Public Member Functions | |
Collection (const Collection &other) | |
Collection (Id id) | |
Collection () | |
~Collection () | |
CachePolicy | cachePolicy () const |
QStringList | contentMimeTypes () const |
QString | name () const |
Id | parent () const |
QString | parentRemoteId () const |
QString | resource () const |
Rights | rights () const |
void | setCachePolicy (const CachePolicy &policy) |
void | setContentMimeTypes (const QStringList &types) |
void | setName (const QString &name) |
void | setParent (const Collection &collection) |
void | setParent (Id parent) |
void | setParentRemoteId (const QString &identifier) |
void | setResource (const QString &identifier) |
void | setRights (Rights rights) |
void | setStatistics (const CollectionStatistics &statistics) |
CollectionStatistics | statistics () const |
KUrl | url () const |
Static Public Member Functions | |
static Collection | fromUrl (const KUrl &url) |
static QString | mimeType () |
static Collection | root () |
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(); } }
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
Describes rights of a collection.
- Enumerator:
Definition at line 86 of file collection.h.
Constructor & Destructor Documentation
Collection::Collection | ( | ) |
Creates an invalid collection.
Definition at line 58 of file collection.cpp.
Collection::Collection | ( | Id | id | ) | [explicit] |
Create a new collection.
- Parameters:
-
id The unique identifier of the collection.
Definition at line 66 of file collection.cpp.
Collection::~Collection | ( | ) |
Destroys the collection.
Definition at line 76 of file collection.cpp.
Collection::Collection | ( | const Collection & | other | ) |
Creates a collection from an other
collection.
Definition at line 71 of file collection.cpp.
Member Function Documentation
CachePolicy Collection::cachePolicy | ( | ) | const |
Returns the cache policy of the collection.
Definition at line 219 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 106 of file collection.cpp.
Collection Collection::fromUrl | ( | const KUrl & | url | ) | [static] |
Creates a collection from the given url
.
Definition at line 151 of file collection.cpp.
QString Collection::mimeType | ( | ) | [static] |
Returns the mimetype used for collections.
Definition at line 173 of file collection.cpp.
QString Collection::name | ( | ) | const |
Returns the i18n'ed name of the collection.
Definition at line 80 of file collection.cpp.
Collection::Id Collection::parent | ( | ) | const |
Returns the identifier of the parent collection.
Definition at line 118 of file collection.cpp.
QString Collection::parentRemoteId | ( | ) | const |
Returns the parent remote identifier.
- Note:
- This usually returns nothing for collections retrieved from the backend.
Definition at line 133 of file collection.cpp.
QString Collection::resource | ( | ) | const |
Returns the identifier of the resource owning the collection.
Definition at line 178 of file collection.cpp.
Collection::Rights Collection::rights | ( | ) | const |
Returns the rights the user has on the collection.
Definition at line 91 of file collection.cpp.
Collection Collection::root | ( | ) | [static] |
Returns the root collection.
Definition at line 168 of file collection.cpp.
void Collection::setCachePolicy | ( | const CachePolicy & | policy | ) |
Sets the cache policy
of the collection.
Definition at line 224 of file collection.cpp.
void Collection::setContentMimeTypes | ( | const QStringList & | types | ) |
Sets the list of possible content mime types
.
Definition at line 111 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 85 of file collection.cpp.
void Collection::setParent | ( | const Collection & | collection | ) |
Sets the parent collection
.
Definition at line 128 of file collection.cpp.
void Collection::setParent | ( | Id | parent | ) |
Sets the identifier of the parent
collection.
Definition at line 123 of file collection.cpp.
void Collection::setParentRemoteId | ( | const QString & | identifier | ) |
Sets the parent's remote identifier
.
Definition at line 138 of file collection.cpp.
void Collection::setResource | ( | const QString & | identifier | ) |
Sets the identifier
of the resource owning the collection.
Definition at line 183 of file collection.cpp.
void Collection::setRights | ( | Rights | rights | ) |
Sets the rights
the user has on the collection.
Definition at line 100 of file collection.cpp.
void Collection::setStatistics | ( | const CollectionStatistics & | statistics | ) |
Sets the collection statistics
for the collection.
Definition at line 213 of file collection.cpp.
CollectionStatistics Collection::statistics | ( | ) | const |
Returns the collection statistics of the collection.
Definition at line 208 of file collection.cpp.
KUrl Collection::url | ( | ) | const |
Returns the collection url.
Definition at line 143 of file collection.cpp.
The documentation for this class was generated from the following files: