Akonadi::CollectionFetchJob

#include <collectionfetchjob.h>

Inheritance diagram for Akonadi::CollectionFetchJob:

[legend]

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

Public Types inherited from QObject
typedef	QObjectList

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)

Public Member Functions
	CollectionFetchJob (const Collection &collection, Type type=FirstLevel, QObject *parent=nullptr)

	CollectionFetchJob (const Collection::List &collections, QObject *parent=nullptr)

	CollectionFetchJob (const Collection::List &collections, Type type, QObject *parent=nullptr)

	CollectionFetchJob (const QList< Collection::Id > &collections, Type type=Base, QObject *parent=nullptr)

	~CollectionFetchJob () override

Collection::List	collections () const

CollectionFetchScope &	fetchScope ()

void	setFetchScope (const CollectionFetchScope &fetchScope)

Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=nullptr)

	~Job () override

QString	errorString () const final

void	start () override

Public Member Functions inherited from KCompositeJob
	KCompositeJob (QObject *parent=nullptr)

Public Member Functions inherited from KJob
	KJob (QObject *parent=nullptr)

Capabilities	capabilities () const

qint64	elapsedTime () const

int	error () const

QString	errorText () const

bool	exec ()

bool	isAutoDelete () const

bool	isFinishedNotificationHidden () const

bool	isStartedWithExec () const

bool	isSuspended () const

unsigned long	percent () const

Q_SCRIPTABLE qulonglong	processedAmount (Unit unit) const

void	setAutoDelete (bool autodelete)

void	setFinishedNotificationHidden (bool hide=true)

void	setUiDelegate (KJobUiDelegate *delegate)

Q_SCRIPTABLE qulonglong	totalAmount (Unit unit) const

KJobUiDelegate *	uiDelegate () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Protected Member Functions
bool	doHandleResponse (qint64 tag, const Protocol::CommandPtr &response) override

void	doStart () override

Protected Member Functions inherited from Akonadi::Job
bool	addSubjob (KJob *job) override

bool	doKill () override

void	emitWriteFinished ()

bool	removeSubjob (KJob *job) override

Protected Member Functions inherited from KCompositeJob
void	clearSubjobs ()

bool	hasSubjobs () const

const QList< KJob * > &	subjobs () const

Protected Member Functions inherited from KJob
virtual bool	doResume ()

virtual bool	doSuspend ()

void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)

void	emitResult ()

void	emitSpeed (unsigned long speed)

bool	isFinished () const

void	setCapabilities (Capabilities capabilities)

void	setError (int errorCode)

void	setErrorText (const QString &errorText)

void	setPercent (unsigned long percentage)

void	setProcessedAmount (Unit unit, qulonglong amount)

void	setProgressUnit (Unit unit)

void	setTotalAmount (Unit unit, qulonglong amount)

void	startElapsedTimer ()

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Properties inherited from QObject
	objectName

Public Slots inherited from KJob
bool	kill (KJob::KillVerbosity verbosity=KJob::Quietly)

bool	resume ()

bool	suspend ()

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from KJob
	Bytes

	Directories

	Files

	Items

	Killable

	NoCapabilities

	Suspendable

	UnitsCount

Protected Slots inherited from Akonadi::Job
void	slotResult (KJob *job) override

Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &message)

virtual void	slotResult (KJob *job)

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.

using namespace Akonadi;
using namespace Qt::StringLiterals;
 
// fetching all collections containing emails recursively, starting at the root collection
auto job = new CollectionFetchJob(Collection::root(), CollectionFetchJob::Recursive, this);
job->fetchScope().setContentMimeTypes({ u"message/rfc822"_s });
connect(job, &CollectionFetchJob::collectionsReceived, this &MyClass::myCollectionsReceived);
connect(job, &KJob::result, this, &MyClass::collectionFetchResult);

Author: Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Definition at line 38 of file collectionfetchjob.h.

Member Enumeration Documentation

◆ Type

enum Akonadi::CollectionFetchJob::Type

Describes the type of fetch depth.

Enumerator
Base	Only fetch the base collection.
FirstLevel	Only list direct sub-collections of the base collection.
Recursive	List all sub-collections.
NonOverlappingRoots	List the roots of a list of fetched collections. Since 4.7

Definition at line 46 of file collectionfetchjob.h.

Constructor & Destructor Documentation

◆ CollectionFetchJob() [1/4]

CollectionFetchJob::CollectionFetchJob	(	const Collection &	collection,
		Type	type = FirstLevel,
		QObject *	parent = nullptr )

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]

CollectionFetchJob::CollectionFetchJob	(	const Collection::List &	collections,
		QObject *	parent = nullptr )

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.

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]

CollectionFetchJob::CollectionFetchJob	(	const QList< Collection::Id > &	collections,
		Type	type = Base,
		QObject *	parent = nullptr )

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()

CollectionFetchJob::~CollectionFetchJob ( )

overridedefault

Destroys the collection fetch job.

Member Function Documentation

◆ collections()

Akonadi::Collection::List CollectionFetchJob::collections ( ) const

nodiscard

Returns the list of fetched collection.

Definition at line 169 of file collectionfetchjob.cpp.

◆ collectionsReceived

void Akonadi::CollectionFetchJob::collectionsReceived ( const Akonadi::Collection::List & collections )

signal

This signal is emitted whenever the job has received collections.

Parameters

collections The received collections.

◆ doHandleResponse()

bool CollectionFetchJob::doHandleResponse	(	qint64	tag,
		const Protocol::CommandPtr &	response )

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()

void CollectionFetchJob::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 ( )

nodiscard

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:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Akonadi

Akonadi::CollectionFetchJob

Public Types

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ CollectionFetchJob() [1/4]

◆ CollectionFetchJob() [2/4]

◆ CollectionFetchJob() [3/4]

◆ CollectionFetchJob() [4/4]

◆ ~CollectionFetchJob()

Member Function Documentation

◆ collections()

◆ collectionsReceived

◆ doHandleResponse()

◆ doStart()

◆ fetchScope()

◆ setFetchScope()