Akonadi::SearchCreateJob

#include <searchcreatejob.h>

Inheritance diagram for Akonadi::SearchCreateJob:

[legend]

Public Member Functions
	SearchCreateJob (const QString &name, const SearchQuery &searchQuery, QObject *parent=nullptr)

	~SearchCreateJob () override

Collection	createdCollection () const

bool	isRecursive () const

bool	isRemoteSearchEnabled () const

QList< Collection >	searchCollections () const

QStringList	searchMimeTypes () const

void	setRecursive (bool recursive)

void	setRemoteSearchEnabled (bool enabled)

void	setSearchCollections (const QList< Collection > &collections)

void	setSearchMimeTypes (const QStringList &mimeTypes)

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

Properties inherited from QObject
	objectName

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 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 creates a virtual/search collection in the Akonadi storage.

This job creates so called virtual or search collections, which don't contain real data, but references to items that match a given search query.

const QString name = "My search folder";
const QString query = "...";
 
Akonadi::SearchCreateJob *job = new Akonadi::SearchCreateJob( name, query );
connect( job, SIGNAL(result(KJob*)), SLOT(jobFinished(KJob*)) );
 
MyClass::jobFinished( KJob *job )
{
  if ( job->error() ) {
    qDebug() << "Error occurred";
    return;
  }
 
  qDebug() << "Created search folder successfully";
  const Collection searchCollection = job->createdCollection();
  ...
}

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

Definition at line 49 of file searchcreatejob.h.

Constructor & Destructor Documentation

◆ SearchCreateJob()

SearchCreateJob::SearchCreateJob	(	const QString &	name,
		const SearchQuery &	searchQuery,
		QObject *	parent = nullptr )

Creates a search create job.

Parameters

name	The name of the search collection
searchQuery	The search query
parent	The parent object

Since: 4.13

Definition at line 54 of file searchcreatejob.cpp.

◆ ~SearchCreateJob()

SearchCreateJob::~SearchCreateJob ( )

override

Destroys the search create job.

Definition at line 59 of file searchcreatejob.cpp.

Member Function Documentation

◆ createdCollection()

Akonadi::Collection SearchCreateJob::createdCollection ( ) const

nodiscard

Returns the newly created search collection once the job finished successfully.

Returns an invalid collection if the job has not yet finished or failed.

Since: 4.4

Definition at line 133 of file searchcreatejob.cpp.

◆ doHandleResponse()

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

overrideprotectedvirtual

Reimplemented from Akonadi::Job.

Definition at line 139 of file searchcreatejob.cpp.

◆ doStart()

void SearchCreateJob::doStart ( )

overrideprotectedvirtual

Reimplemented from Akonadi::Job.

Implements Akonadi::Job.

Definition at line 111 of file searchcreatejob.cpp.

◆ isRecursive()

bool SearchCreateJob::isRecursive ( ) const

nodiscard

Returns whether the search is recursive.

Since: 4.13

Definition at line 94 of file searchcreatejob.cpp.

◆ isRemoteSearchEnabled()

bool SearchCreateJob::isRemoteSearchEnabled ( ) const

nodiscard

Returns whether remote search is enabled.

Since: 4.13

Definition at line 106 of file searchcreatejob.cpp.

◆ searchCollections()

QList< Collection > SearchCreateJob::searchCollections ( ) const

nodiscard

Returns list of collections to search in.

Since: 4.13

Definition at line 70 of file searchcreatejob.cpp.

◆ searchMimeTypes()

QStringList SearchCreateJob::searchMimeTypes ( ) const

nodiscard

Returns list of mime types that search results can contain.

Since: 4.13

Definition at line 82 of file searchcreatejob.cpp.

◆ setRecursive()

void SearchCreateJob::setRecursive ( bool recursive )

Sets whether the search should recurse into collections.

When set to true, all child collections of the specific collections will be search recursively.

Parameters

recursive Whether to search recursively

Since: 4.13

Definition at line 87 of file searchcreatejob.cpp.

◆ setRemoteSearchEnabled()

void SearchCreateJob::setRemoteSearchEnabled ( bool enabled )

Sets whether resources should be queried too.

When set to true, Akonadi will search local indexed items and will also query resources that support server-side search, to forward the query to remote storage (for example using SEARCH feature on IMAP servers) and merge their results with results from local index.

This is useful especially when searching resources, that don't fetch full payload by default, for example the IMAP resource, which only fetches headers by default and the body is fetched on demand, which means that emails that were not yet fully fetched cannot be indexed in local index, and thus cannot be searched. With remote search, even those emails can be included in search results.

This feature is disabled by default.

Parameters

enabled Whether remote search is enabled

Since: 4.13

Definition at line 99 of file searchcreatejob.cpp.

◆ setSearchCollections()

void SearchCreateJob::setSearchCollections ( const QList< Collection > & collections )

Sets list of collections to search in.

When an empty list is set (default value), the search will contain results from all collections that contain given mime types.

Parameters

collections Collections to search in, or an empty list to search all

Since: 4.13

Definition at line 63 of file searchcreatejob.cpp.

◆ setSearchMimeTypes()

void SearchCreateJob::setSearchMimeTypes ( const QStringList & mimeTypes )

Sets list of mime types of items that search results can contain.

Parameters

mimeTypes Mime types of items to include in search

Since: 4.13

Definition at line 75 of file searchcreatejob.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::SearchCreateJob

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SearchCreateJob()

◆ ~SearchCreateJob()

Member Function Documentation

◆ createdCollection()

◆ doHandleResponse()

◆ doStart()

◆ isRecursive()

◆ isRemoteSearchEnabled()

◆ searchCollections()

◆ searchMimeTypes()

◆ setRecursive()

◆ setRemoteSearchEnabled()

◆ setSearchCollections()

◆ setSearchMimeTypes()