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

akonadi

Akonadi::ItemCreateJob

Akonadi::ItemCreateJob Class Reference

Job that creates a new item in the Akonadi storage. More...

#include <itemcreatejob.h>

Inheritance diagram for Akonadi::ItemCreateJob:

Inheritance graph
[legend]

List of all members.


Public Member Functions

Item item () const
 ItemCreateJob (const Item &item, const Collection &collection, QObject *parent=0)
 ~ItemCreateJob ()

Protected Member Functions

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

Detailed Description

Job that creates a new item in the Akonadi storage.

This job creates a new item with all the set properties in the given target collection.

Example:

 // Create a contact item in the root collection

 KABC::Addressee addr;
 addr.setNameFromString( "Joe Jr. Miller" );

 Akonadi::Item item;
 item.setMimeType( "text/directory" );
 item.setPayload<KABC::Addressee>( addr );

 Akonadi::Collection collection = Akonadi::Collection::root();

 Akonadi::ItemCreateJob *job = new Akonadi::ItemCreateJob( item, collection );

 if ( job->exec() )
   qDebug() << "Contact item created successfully";
 else
   qDebug() << "Error occurred";

Author:
Volker Krause <vkrause@kde.org>

Definition at line 63 of file itemcreatejob.h.


Constructor & Destructor Documentation

ItemCreateJob::ItemCreateJob ( const Item &  item,
const Collection &  collection,
QObject *  parent = 0 
)

Creates a new item create job.

Parameters:
item The item to create.
Note:
It must have a mime type set.
Parameters:
collection The parent collection where the new item shall be located in.
parent The parent object.

Definition at line 49 of file itemcreatejob.cpp.

ItemCreateJob::~ItemCreateJob (  ) 

Destroys the item create job.

Definition at line 60 of file itemcreatejob.cpp.


Member Function Documentation

void ItemCreateJob::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:
tag The tag of the corresponding command, empty if this is an untagged response.
data The received data.

Reimplemented from Akonadi::Job.

Definition at line 113 of file itemcreatejob.cpp.

void ItemCreateJob::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.

Definition at line 64 of file itemcreatejob.cpp.

Item ItemCreateJob::item (  )  const

Returns the created item with the new unique id, or an invalid item if the job failed.

Definition at line 135 of file itemcreatejob.cpp.


The documentation for this class was generated from the following files:
  • itemcreatejob.h
  • itemcreatejob.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
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.7.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