• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

Akonadi::SubscriptionJob

Akonadi::SubscriptionJob Class Reference

#include <subscriptionjob.h>

Inheritance diagram for Akonadi::SubscriptionJob:

Inheritance graph
[legend]

List of all members.


Detailed Description

For internal use only.

Job to manipulate the local subscription state of a set of collections.

Definition at line 35 of file subscriptionjob.h.


Public Member Functions

void subscribe (const Collection::List &list)
 SubscriptionJob (QObject *parent=0)
void unsubscribe (const Collection::List &list)
 ~SubscriptionJob ()

Protected Member Functions

void doHandleResponse (const QByteArray &tag, const QByteArray &data)
void doStart ()

Constructor & Destructor Documentation

SubscriptionJob::SubscriptionJob ( QObject *  parent = 0  )  [explicit]

Create a new subscription job.

Parameters:
parent The parent object.

Definition at line 69 of file subscriptionjob.cpp.

SubscriptionJob::~SubscriptionJob (  ) 

Destroys this job.

Definition at line 74 of file subscriptionjob.cpp.


Member Function Documentation

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

void SubscriptionJob::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.

Definition at line 92 of file subscriptionjob.cpp.

void SubscriptionJob::subscribe ( const Collection::List &  list  ) 

Subscribe to the given list of collections.

Parameters:
list List of collections to subscribe to.

Definition at line 78 of file subscriptionjob.cpp.

void SubscriptionJob::unsubscribe ( const Collection::List &  list  ) 

Unsubscribe from the given list of collections.

Parameters:
list List of collections to unsubscribe from.

Definition at line 85 of file subscriptionjob.cpp.


The documentation for this class was generated from the following files:
  • subscriptionjob.h
  • subscriptionjob.cpp

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.6
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