Akonadi::TagFetchJob Class Reference

#include <tagfetchjob.h>

Inheritance diagram for Akonadi::TagFetchJob:

Signals
void	tagsReceived (const Akonadi::Tag::List &tags)
Signals inherited from Akonadi::Job
void	aboutToStart (Akonadi::Job *job)
void	writeFinished (Akonadi::Job *job)

Public Member Functions
	TagFetchJob (QObject *parent=0)
	TagFetchJob (const Tag &tag, QObject *parent=0)
	TagFetchJob (const Tag::List &tags, QObject *parent=0)
	TagFetchJob (const QList< Tag::Id > &ids, QObject *parent=0)
TagFetchScope &	fetchScope ()
void	setFetchScope (const TagFetchScope &fetchScope)
Tag::List	tags () const
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

Protected Member Functions
virtual void	doHandleResponse (const QByteArray &tag, const QByteArray &data)
virtual 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
Protected Slots inherited from Akonadi::Job
virtual void	slotResult (KJob *job)

Detailed Description

Job that fetches tags from the Akonadi storage.

This class is used to fetch tags from the Akonadi storage.

If you want to fetch all items with given tag, use ItemFetchJob and the ItemFetchJob(const Tag &tag, QObject *parent = 0) constructor (since 4.14)

Since

4.13

Definition at line 41 of file tagfetchjob.h.

Constructor & Destructor Documentation

TagFetchJob::TagFetchJob ( QObject *  parent = 0 )

explicit

Constructs a new tag fetch job that retrieves all tags stored in Akonadi.

Parameters

parent

The parent object.

Definition at line 75 of file tagfetchjob.cpp.

TagFetchJob::TagFetchJob ( const Tag &  tag, QObject *  parent = 0  )

explicit

Constructs a new tag fetch job that retrieves the specified tag.

If the tag has a uid set, this is used to identify the tag on the Akonadi server. If only a remote identifier is available, that is used. However as remote identifiers are internal to resources, it's necessary to set the resource context (see ResourceSelectJob).

Parameters

tag	The tag to fetch.
parent	The parent object.

Definition at line 82 of file tagfetchjob.cpp.

TagFetchJob::TagFetchJob ( const Tag::List &  tags, QObject *  parent = 0  )

explicit

Constructs a new tag fetch job that retrieves specified tags.

If the tags have a uid set, this is used to identify the tags on the Akonadi server. If only a remote identifier is available, that is used. However as remote identifiers are internal to resources, it's necessary to set the resource context (see ResourceSelectJob).

Parameters

tags	Tags to fetch.
parent	The parent object.

Definition at line 90 of file tagfetchjob.cpp.

TagFetchJob::TagFetchJob ( const QList< Tag::Id > &  ids, QObject *  parent = 0  )

explicit

Convenience ctor equivalent to ItemFetchJob(const Item::List &items, QObject *parent = 0)

Parameters

ids	UIDs of tags to fetch.
parent	The parent object.

Definition at line 98 of file tagfetchjob.cpp.

Member Function Documentation

void TagFetchJob::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 142 of file tagfetchjob.cpp.

void TagFetchJob::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 120 of file tagfetchjob.cpp.

TagFetchScope & TagFetchJob::fetchScope

(

)

Returns the tag 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 TagFetchScope documentation for an example.

Returns

a reference to the current tag fetch scope

See also

setFetchScope() for replacing the current tag fetch scope

Definition at line 114 of file tagfetchjob.cpp.

void TagFetchJob::setFetchScope

(

const TagFetchScope &

fetchScope

)

Sets the tag fetch scope.

The TagFetchScope controls how much of an tags's data is fetched from the server.

Parameters

fetchScope

The new fetch scope for tag fetch operations.

See also

fetchScope()

Definition at line 108 of file tagfetchjob.cpp.

Tag::List TagFetchJob::tags

(

)

const

Returns the fetched tags after the job has been completed.

Definition at line 169 of file tagfetchjob.cpp.

void Akonadi::TagFetchJob::tagsReceived ( const Akonadi::Tag::List &  tags )

signal

This signal is emitted whenever new tags have been fetched completely.

Parameters

items

The fetched tags.

---

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

• tagfetchjob.h
• tagfetchjob.cpp