Akonadi::CollectionDeleteJob Class Reference

#include <collectiondeletejob.h>

Inheritance diagram for Akonadi::CollectionDeleteJob:

Public Member Functions
	CollectionDeleteJob (const Collection &collection, QObject *parent=0)
	~CollectionDeleteJob ()
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 deletes a collection in the Akonadi storage.

This job deletes a collection and all its sub-collections as well as all associated content.

Akonadi::Collection collection = ...

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

Note

This job deletes the data from the backend storage. To delete the collection from the Akonadi storage only, leaving the backend storage unchanged, delete the Agent instead, as follows. (Note that if it's a sub-collection, deleting the agent will also delete its parent collection; in this case the only option is to delete the sub-collection data in both Akonadi and backend storage.)

const Akonadi::AgentInstance instance =
                  Akonadi::AgentManager::self()->instance( collection.resource() );
if ( instance.isValid() ) {
  Akonadi::AgentManager::self()->removeInstance( instance );
}

Author

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

Definition at line 63 of file collectiondeletejob.h.

Constructor & Destructor Documentation

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

explicit

Creates a new collection delete job.

The collection needs to either have a unique identifier or a remote identifier set. Note that using a remote identifier only works in a resource context (that is from within ResourceBase), as remote identifiers are not guaranteed to be globally unique.

Parameters

collection	The collection to delete.
parent	The parent object.

Definition at line 41 of file collectiondeletejob.cpp.

CollectionDeleteJob::~CollectionDeleteJob

(

)

Destroys the collection delete job.

Definition at line 49 of file collectiondeletejob.cpp.

Member Function Documentation

void CollectionDeleteJob::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 53 of file collectiondeletejob.cpp.

---

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

• collectiondeletejob.h
• collectiondeletejob.cpp