Akonadi::CollectionFetchJob
#include <collectionfetchjob.h>
Public Types | |
enum | Type { Base , FirstLevel , Recursive , NonOverlappingRoots } |
Public Types inherited from Akonadi::Job | |
enum | Error { ConnectionFailed = UserDefinedError , ProtocolVersionMismatch , UserCanceled , Unknown , UserError = UserDefinedError + 42 } |
using | List = QList<Job *> |
Public Types inherited from KJob | |
typedef QFlags< Capability > | Capabilities |
enum | Capability |
enum | Unit |
Signals | |
void | collectionsReceived (const Akonadi::Collection::List &collections) |
Signals inherited from Akonadi::Job | |
void | aboutToStart (Akonadi::Job *job) |
void | writeFinished (Akonadi::Job *job) |
Signals inherited from KJob | |
void | description (KJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< QString, QString >()) |
void | finished (KJob *job) |
void | infoMessage (KJob *job, const QString &message) |
void | percentChanged (KJob *job, unsigned long percent) |
void | processedAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount) |
void | processedSize (KJob *job, qulonglong size) |
void | result (KJob *job) |
void | resumed (KJob *job) |
void | speed (KJob *job, unsigned long speed) |
void | suspended (KJob *job) |
void | totalAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount) |
void | totalSize (KJob *job, qulonglong size) |
void | warning (KJob *job, const QString &message) |
Detailed Description
Job that fetches collections from the Akonadi storage.
This class can be used to retrieve the complete or partial collection tree from the Akonadi storage. This fetches collection data, not item data.
Definition at line 39 of file collectionfetchjob.h.
Member Enumeration Documentation
◆ Type
Describes the type of fetch depth.
Definition at line 47 of file collectionfetchjob.h.
Constructor & Destructor Documentation
◆ CollectionFetchJob() [1/4]
|
explicit |
Creates a new collection fetch job.
If the given base collection has a unique identifier, this is used to identify the collection in the Akonadi server. If only a remote identifier is available the collection is identified using that, provided that a resource search context has been specified by calling setResource().
For internal use only, if a remote identifier is set, the resource search context can be set globally using ResourceSelectJob.
- Parameters
-
collection The base collection for the listing. type The type of fetch depth. parent The parent object.
Definition at line 110 of file collectionfetchjob.cpp.
◆ CollectionFetchJob() [2/4]
|
explicit |
Creates a new collection fetch job to retrieve a list of collections.
If a given collection has a unique identifier, this is used to identify the collection in the Akonadi server. If only a remote identifier is available the collection is identified using that, provided that a resource search context has been specified by calling setResource().
For internal use only, if a remote identifier is set, the resource search context can be set globally using ResourceSelectJob.
- Parameters
-
collections A list of collections to fetch. Must not be empty. parent The parent object.
Definition at line 120 of file collectionfetchjob.cpp.
◆ CollectionFetchJob() [3/4]
CollectionFetchJob::CollectionFetchJob | ( | const Collection::List & | collections, |
Type | type, | ||
QObject * | parent = nullptr ) |
Creates a new collection fetch job to retrieve a list of collections.
If a given collection has a unique identifier, this is used to identify the collection in the Akonadi server. If only a remote identifier is available the collection is identified using that, provided that a resource search context has been specified by calling setResource().
For internal use only, if a remote identifier is set, the resource search context can be set globally using ResourceSelectJob.
- Parameters
-
collections A list of collections to fetch. Must not be empty. type The type of fetch depth. parent The parent object.
- Todo
- KDE5 merge with ctor above.
- Since
- 4.7
Definition at line 135 of file collectionfetchjob.cpp.
◆ CollectionFetchJob() [4/4]
|
explicit |
Convenience ctor equivalent to CollectionFetchJob(const Collection::List &collections, Type type, QObject *parent = nullptr)
- Since
- 4.8
- Parameters
-
collections list of collection ids type fetch job type parent parent object
Definition at line 150 of file collectionfetchjob.cpp.
◆ ~CollectionFetchJob()
|
overridedefault |
Destroys the collection fetch job.
Member Function Documentation
◆ collections()
Akonadi::Collection::List CollectionFetchJob::collections | ( | ) | const |
Returns the list of fetched collection.
Definition at line 169 of file collectionfetchjob.cpp.
◆ collectionsReceived
|
signal |
This signal is emitted whenever the job has received collections.
- Parameters
-
collections The received collections.
◆ doHandleResponse()
|
overrideprotectedvirtual |
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. response The received response
- Returns
- Implementations should return true if the last response was processed and the job can emit result. Return false if more responses from server are expected.
Reimplemented from Akonadi::Job.
Definition at line 272 of file collectionfetchjob.cpp.
◆ doStart()
|
overrideprotectedvirtual |
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 176 of file collectionfetchjob.cpp.
◆ fetchScope()
CollectionFetchScope & CollectionFetchJob::fetchScope | ( | ) |
Returns the collection fetch scope.
Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable. See the CollectionFetchScope documentation for an example.
- Returns
- a reference to the current collection fetch scope
- See also
- setFetchScope() for replacing the current collection fetch scope
- Since
- 4.4
Definition at line 405 of file collectionfetchjob.cpp.
◆ setFetchScope()
void CollectionFetchJob::setFetchScope | ( | const CollectionFetchScope & | fetchScope | ) |
Sets the collection fetch scope.
The CollectionFetchScope controls how much of a collection's data is fetched from the server as well as a filter to select which collections to fetch.
- Parameters
-
fetchScope The new scope for collection fetch operations.
- See also
- fetchScope()
- Since
- 4.4
Definition at line 399 of file collectionfetchjob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:13:38 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.