• Skip to content
  • Skip to link menu
KDE 4.7 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • CollectionCreateJob
Public Member Functions | Protected Member Functions
Akonadi::CollectionCreateJob Class Reference

#include <collectioncreatejob.h>

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

List of all members.

Public Member Functions

 CollectionCreateJob (const Collection &collection, QObject *parent=0)
virtual ~CollectionCreateJob ()
Collection collection () const

Protected Member Functions

virtual void doHandleResponse (const QByteArray &tag, const QByteArray &data)
virtual void doStart ()

Detailed Description

Job that creates a new collection in the Akonadi storage.

This job creates a new collection with all the set properties. You have to use setParentCollection() to define the collection, the new collection shall be located in.

 // create a new top-level collection
 Akonadi::Collection collection;
 collection.setParentCollection( Collection::root() );
 collection.setName( "Events" );
 collection.setContentMimeTypes( QStringList( "text/calendar" ) );

 Akonadi::CollectionCreateJob *job = new Akonadi::CollectionCreateJob( collection );
 connect( job, SIGNAL( result( KJob* ) ), this, SLOT( createResult( KJob* ) ) );
Author:
Volker Krause <vkrause@kde.org>

Constructor & Destructor Documentation

CollectionCreateJob::CollectionCreateJob ( const Collection &  collection,
QObject *  parent = 0 
) [explicit]

Creates a new collection create job.

Parameters:
collectionThe new collection. collection must have a parent collection set with a unique identifier. If a resource context is specified in the current session (that is you are using it within Akonadi::ResourceBase), the parent collection can be identified by its remote identifier as well.
parentThe parent object.

Definition at line 41 of file collectioncreatejob.cpp.

CollectionCreateJob::~CollectionCreateJob ( ) [virtual]

Destroys the collection create job.

Definition at line 49 of file collectioncreatejob.cpp.


Member Function Documentation

Collection Akonadi::CollectionCreateJob::collection ( ) const

Returns the created collection if the job was executed succesfull.

virtual void Akonadi::CollectionCreateJob::doHandleResponse ( const QByteArray &  tag,
const QByteArray &  data 
) [protected, virtual]

This method should be reimplemented in the concrete jobs in case you want to handle incoming data.

It will be called on received data from the backend. The default implementation does nothing.

Parameters:
tagThe tag of the corresponding command, empty if this is an untagged response.
dataThe received data.

Reimplemented from Akonadi::Job.

virtual void Akonadi::CollectionCreateJob::doStart ( ) [protected, virtual]

This method must be reimplemented in the concrete jobs.

It will be called after the job has been started and a connection to the Akonadi backend has been established.

Implements Akonadi::Job.


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

akonadi

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.5
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