Akonadi::ItemCreateJob Class Reference

#include <itemcreatejob.h>

Inheritance diagram for Akonadi::ItemCreateJob:

Public Types
enum	MergeOption { NoMerge = 0, RID = 1, GID = 2, Silent = 4 }
Public Types inherited from Akonadi::Job
enum	Error {   ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,   UserError = UserDefinedError + 42 }
typedef QList< Job * >	List

Public Member Functions
	ItemCreateJob (const Item &item, const Collection &collection, QObject *parent=0)
	~ItemCreateJob ()
Item	item () const
void	setMerge (MergeOptions options)
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

Protected Member Functions
virtual void	doHandleResponse (const QByteArray &tag, const QByteArray &data)
virtual void	doStart ()
Protected Member Functions inherited from Akonadi::Job
virtual bool	addSubjob (KJob *job)
virtual bool	doKill ()
void	emitWriteFinished ()
virtual bool	removeSubjob (KJob *job)

Additional Inherited Members
Signals inherited from Akonadi::Job
void	aboutToStart (Akonadi::Job *job)
void	writeFinished (Akonadi::Job *job)
Protected Slots inherited from Akonadi::Job
virtual void	slotResult (KJob *job)

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 vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Definition at line 73 of file itemcreatejob.h.

Member Enumeration Documentation

enum Akonadi::ItemCreateJob::MergeOption

Enumerator
NoMerge	Don't merge.
RID	Merge by remote id.
GID	Merge by GID.
Silent	Only return the id of the merged/created item.

Definition at line 98 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 90 of file itemcreatejob.cpp.

ItemCreateJob::~ItemCreateJob

(

)

Destroys the item create job.

Definition at line 101 of file itemcreatejob.cpp.

Member Function Documentation

void ItemCreateJob::doHandleResponse ( const QByteArray &  tag, const QByteArray &  data  )

protectedvirtual

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 193 of file itemcreatejob.cpp.

void ItemCreateJob::doStart ( )

protectedvirtual

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 105 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 255 of file itemcreatejob.cpp.

void ItemCreateJob::setMerge

(

MergeOptions

options

)

Merge this item into an existing one if available.

If an item with same GID and/or remote ID as the created item exists in specified collection (depending on the provided options), the new item will be merged into the existing one and the merged item will be returned (unless the Silent option is used).

If no matching item is found a new item is created.

If the item does not have a GID or RID, this option will be ignored and a new item will be created.

By default, merging is disabled.

Parameters

options

Merge options.

Since

4.14

Definition at line 248 of file itemcreatejob.cpp.

---

The documentation for this class was generated from the following files:

• itemcreatejob.h
• itemcreatejob.cpp