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

akonadi

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

#include <itemcreatejob.h>

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

List of all members.

Public Member Functions

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

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.

Note that items can not be created in the root collection (Collection::root()) and the collection must have Collection::contentMimeTypes() that match the mimetype of the item being created.

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 = getCollection();

 Akonadi::ItemCreateJob *job = new Akonadi::ItemCreateJob( item, collection );
 connect( job, SIGNAL( result( KJob* ) ), SLOT( jobFinished( KJob* ) ) );

 ...

 MyClass::jobFinished( KJob *job )
 {
   if ( job->error() )
     qDebug() << "Error occurred";
   else
     qDebug() << "Contact item created successfully";
 }
Author:
Volker Krause <vkrause@kde.org>

Constructor & Destructor Documentation

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

Creates a new item create job.

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

Definition at line 52 of file itemcreatejob.cpp.

ItemCreateJob::~ItemCreateJob ( )

Destroys the item create job.

Definition at line 63 of file itemcreatejob.cpp.


Member Function Documentation

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

Reimplemented from Akonadi::Job.

virtual void Akonadi::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.

Item Akonadi::ItemCreateJob::item ( ) const

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


The documentation for this class was generated from the following files:
  • itemcreatejob.h
  • itemcreatejob.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