Akonadi::SubscriptionJob Class Reference
Job to manipulate the local subscription state of a set of collections. More...
#include <subscriptionjob_p.h>
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.
For internal use only.
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 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:
-
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 97 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 90 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 76 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 83 of file subscriptionjob.cpp.
The documentation for this class was generated from the following files:
