akonadi
Akonadi::Collection Class Reference
#include <collection.h>

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 ); if ( job->exec() ) { Collection::List collections = job->collections(); foreach( const Collection &collection, collections ) { qDebug() << "Name:" << collection.name(); } }
- See also:
- Akonadi Collection Concept
Definition at line 65 of file collection.h.
Member Typedef Documentation
typedef QList<Collection> Akonadi::Collection::List |
Member Enumeration Documentation
Describes rights of a collection.
- Enumerator:
Definition at line 76 of file collection.h.
Constructor & Destructor Documentation
Collection::Collection | ( | ) |
Collection::Collection | ( | Id | id | ) | [explicit] |
Create a new collection.
- Parameters:
-
id The unique identifier of the collection.
Definition at line 59 of file collection.cpp.
Collection::~Collection | ( | ) |
Collection::Collection | ( | const Collection & | other | ) |
Member Function Documentation
CachePolicy Collection::cachePolicy | ( | ) | const |
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 99 of file collection.cpp.
Collection Collection::fromUrl | ( | const KUrl & | url | ) | [static] |
QString Collection::mimeType | ( | ) | [static] |
QString Collection::name | ( | ) | const |
Collection::Id Collection::parent | ( | ) | const |
QString Collection::parentRemoteId | ( | ) | const |
Returns the parent remote identifier.
- Note:
- This usually returns nothing for collections retrieved from the backend.
Definition at line 129 of file collection.cpp.
QString Collection::resource | ( | ) | const |
Returns the identifier of the resource owning the collection.
Definition at line 175 of file collection.cpp.
Collection::Rights Collection::rights | ( | ) | const |
Collection Collection::root | ( | ) | [static] |
void Collection::setCachePolicy | ( | const CachePolicy & | policy | ) |
void Collection::setContentMimeTypes | ( | const QStringList & | types | ) |
void Collection::setName | ( | const QString & | name | ) |
Sets the i18n'ed name of the collection.
- Parameters:
-
name The new collection name.
Definition at line 78 of file collection.cpp.
void Collection::setParent | ( | const Collection & | collection | ) |
void Collection::setParent | ( | Id | parent | ) |
void Collection::setParentRemoteId | ( | const QString & | identifier | ) |
void Collection::setResource | ( | const QString & | identifier | ) |
Sets the identifier
of the resource owning the collection.
Definition at line 180 of file collection.cpp.
void Collection::setRights | ( | Rights | rights | ) |
void Collection::setStatistics | ( | const CollectionStatistics & | statistics | ) |
CollectionStatistics Collection::statistics | ( | ) | const |
KUrl Collection::url | ( | ) | const |
The documentation for this class was generated from the following files: