Akonadi::CollectionModifyJob Class Reference

#include <collectionmodifyjob.h>

Inheritance diagram for Akonadi::CollectionModifyJob:

Public Member Functions
	CollectionModifyJob (const Collection &collection, QObject *parent=0)
	~CollectionModifyJob ()
Collection	collection () const
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

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

Additional Inherited Members
Public Types inherited from Akonadi::Job
enum	Error {   ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,   UserError = UserDefinedError + 42 }
typedef QList< Job * >	List
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 modifies a collection in the Akonadi storage.

This job modifies the properties of an existing collection.

Akonadi::Collection collection = ...

Akonadi::CollectionModifyJob *job = new Akonadi::CollectionModifyJob( collection );
connect( job, SIGNAL(result(KJob*)), this, SLOT(modifyResult(KJob*)) );

If the collection has attributes, it is recommended only to supply values for any attributes whose values are to be updated. This will help to avoid potential clashes with other resources or applications which may happen to update the collection simultaneously. To avoid supplying attribute values which are not needed, create a new instance of the collection and explicitly set attributes to be updated, e.g.

// Update the 'MyAttribute' attribute of 'collection'.
Akonadi::Collection c( collection.id() );
MyAttribute *attribute = c.attribute<MyAttribute>( Entity::AddIfMissing );
if ( collection.hasAttribute<MyAttribute>() ) {
    *attribute = *collection.attribute<MyAttribute>();
}
// Update the value of 'attribute' ...
Akonadi::CollectionModifyJob *job = new Akonadi::CollectionModifyJob( c );
connect( job, SIGNAL(result(KJob*)), this, SLOT(modifyResult(KJob*)) );

To update only the collection, and not change any attributes:

// Update the cache policy for 'collection' to 'newPolicy'.
Akonadi::Collection c( collection.id() );
c.setCachePolicy( newPolicy );
Akonadi::CollectionModifyJob *job = new Akonadi::CollectionModifyJob( c );
connect( job, SIGNAL(result(KJob*)), this, SLOT(modifyResult(KJob*)) );

Author

Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Definition at line 82 of file collectionmodifyjob.h.

Constructor & Destructor Documentation

CollectionModifyJob::CollectionModifyJob ( const Collection &  collection, QObject *  parent = 0  )

explicit

Creates a new collection modify job for the given collection.

The collection can be identified either by its unique identifier or its remote identifier. Since the remote identifier is not necessarily globally unique, identification by remote identifier only works inside a resource context (that is from within ResourceBase) and is therefore limited to one resource.

Parameters

collection	The collection to modify.
parent	The parent object.

Definition at line 49 of file collectionmodifyjob.cpp.

CollectionModifyJob::~CollectionModifyJob

(

)

Destroys the collection modify job.

Definition at line 56 of file collectionmodifyjob.cpp.

Member Function Documentation

Collection CollectionModifyJob::collection

(

)

const

Returns the modified collection.

Since

4.4

Definition at line 123 of file collectionmodifyjob.cpp.

void CollectionModifyJob::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 60 of file collectionmodifyjob.cpp.

---

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

• collectionmodifyjob.h
• collectionmodifyjob.cpp