• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.8.5 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • SubscriptionJob
Public Member Functions | Protected Member Functions
Akonadi::SubscriptionJob Class Reference

#include <subscriptionjob_p.h>

Inheritance diagram for Akonadi::SubscriptionJob:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Protected Member Functions

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

Detailed Description

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


Constructor & Destructor Documentation

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

Creates a new subscription job.

Parameters:
parentThe parent object.

Definition at line 67 of file subscriptionjob.cpp.

SubscriptionJob::~SubscriptionJob ( )

Destroys the subscription job.

Definition at line 72 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:
tagThe tag of the corresponding command, empty if this is an untagged response.
dataThe received data.

Reimplemented from Akonadi::Job.

Definition at line 95 of file collectioncreatejob.cpp.

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

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

Subscribes to the given list of collections.

Parameters:
collectionsList of collections to subscribe to.

Definition at line 76 of file subscriptionjob.cpp.

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

Unsubscribes from the given list of collections.

Parameters:
collectionsList of collections to unsubscribe from.

Definition at line 83 of file subscriptionjob.cpp.


The documentation for this class was generated from the following files:
  • subscriptionjob_p.h
  • collectioncreatejob.cpp
  • collectionfetchjob.cpp
  • collectionstatisticsjob.cpp
  • itemcreatejob.cpp
  • itemfetchjob.cpp
  • itemmodifyjob.cpp
  • itemsearchjob.cpp
  • job.cpp
  • searchcreatejob.cpp
  • subscriptionjob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Aug 27 2012 22:09:28 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

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

kdepimlibs-4.8.5 API Reference

Skip menu "kdepimlibs-4.8.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal