Akonadi::SubscriptionJob Class Reference

#include <subscriptionjob_p.h>

Inheritance diagram for Akonadi::SubscriptionJob:

Public Member Functions
	SubscriptionJob (QObject *parent=0)
	~SubscriptionJob ()
void	subscribe (const Collection::List &collections)
void	unsubscribe (const Collection::List &collections)
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

Protected Member Functions
void	doHandleResponse (const QByteArray &tag, const QByteArray &data)
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
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 to manipulate the local subscription state of a set of collections.

Definition at line 35 of file subscriptionjob_p.h.

Constructor & Destructor Documentation

SubscriptionJob::SubscriptionJob ( QObject *  parent = 0 )

explicit

Creates a new subscription job.

Parameters

parent

The parent object.

Definition at line 68 of file subscriptionjob.cpp.

SubscriptionJob::~SubscriptionJob

(

)

Destroys the subscription job.

Definition at line 73 of file subscriptionjob.cpp.

Member Function Documentation

void SubscriptionJob::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 98 of file subscriptionjob.cpp.

void SubscriptionJob::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 91 of file subscriptionjob.cpp.

void SubscriptionJob::subscribe

(

const Collection::List &

collections

)

Subscribes to the given list of collections.

Parameters

collections

List of collections to subscribe to.

Definition at line 77 of file subscriptionjob.cpp.

void SubscriptionJob::unsubscribe

(

const Collection::List &

collections

)

Unsubscribes from the given list of collections.

Parameters

collections

List of collections to unsubscribe from.

Definition at line 84 of file subscriptionjob.cpp.

---

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

• subscriptionjob_p.h
• subscriptionjob.cpp