• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

Akonadi::Collection

Akonadi::Collection Class Reference

Represents a collection of PIM items. More...

#include <collection.h>

Inheritance diagram for Akonadi::Collection:
Inheritance graph
[legend]

List of all members.

Public Types

typedef QList< Collection > List
enum  Right {
  ReadOnly = 0x0, CanChangeItem = 0x1, CanCreateItem = 0x2, CanDeleteItem = 0x4,
  CanChangeCollection = 0x8, CanCreateCollection = 0x10, CanDeleteCollection = 0x20, AllRights
}

Public Member Functions

CachePolicy cachePolicy () const
 Collection (const Collection &other)
 Collection (Id id)
 Collection ()
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
 ~Collection ()

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 );
 if ( job->exec() ) {
   Collection::List collections = job->collections();
   foreach( const Collection &collection, collections ) {
     qDebug() << "Name:" << collection.name();
   }
 }
Author:
Volker Krause <vkrause@kde.org>
See also:
Akonadi Collection Concept

Definition at line 65 of file collection.h.


Member Typedef Documentation

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

Describes a list of collections.

Definition at line 71 of file collection.h.


Member Enumeration Documentation

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 subcollections in this collection.

CanCreateCollection 

Can create new subcollections in this collection.

CanDeleteCollection 

Can delete subcollections in this collection.

AllRights 

Has all rights on this collection.

Definition at line 76 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 225 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 155 of file collection.cpp.

QString Collection::mimeType (  )  [static]

Returns the mimetype used for collections.

Definition at line 177 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 136 of file collection.cpp.

QString Collection::resource (  )  const

Returns the identifier of the resource owning the collection.

Definition at line 182 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 172 of file collection.cpp.

void Collection::setCachePolicy ( const CachePolicy &  policy  ) 

Sets the cache policy of the collection.

Definition at line 230 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 129 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 141 of file collection.cpp.

void Collection::setResource ( const QString &  identifier  ) 

Sets the identifier of the resource owning the collection.

Definition at line 187 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 219 of file collection.cpp.

CollectionStatistics Collection::statistics (  )  const

Returns the collection statistics of the collection.

Definition at line 214 of file collection.cpp.

KUrl Collection::url (  )  const

Returns the collection url.

Definition at line 147 of file collection.cpp.


The documentation for this class was generated from the following files:
  • collection.h
  • collection.cpp

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal