Akonadi::ContactSearchJob Class Reference

#include <contactsearchjob.h>

Inheritance diagram for Akonadi::ContactSearchJob:

Public Types
enum	Criterion {   Name , Email , NickName , NameOrEmail ,   ContactUid }
enum	Match { ExactMatch , StartsWithMatch , ContainsMatch , ContainsWordBoundaryMatch }
Public Types inherited from Akonadi::Job
enum	Error
typedef QList< Job * >	List
Public Types inherited from KJob
typedef QFlags< Capability >	Capabilities
enum	Capability
enum	Unit

Public Member Functions
	ContactSearchJob (QObject *parent=nullptr)
	~ContactSearchJob () override
KContacts::Addressee::List	contacts () const
void	setLimit (int limit)
void	setQuery (Criterion criterion, const QString &value, Match match=ExactMatch)
Public Member Functions inherited from Akonadi::ItemSearchJob
	ItemSearchJob (const SearchQuery &query, QObject *parent=nullptr)
	ItemSearchJob (QObject *parent=nullptr)
ItemFetchScope &	fetchScope ()
bool	isRecursive () const
bool	isRemoteSearchEnabled () const
Item::List	items () const
QStringList	mimeTypes () const
Collection::List	searchCollections () const
void	setFetchScope (const ItemFetchScope &fetchScope)
void	setMimeTypes (const QStringList &mimeTypes)
void	setQuery (const SearchQuery &query)
void	setRecursive (bool recursive)
void	setRemoteSearchEnabled (bool enabled)
void	setSearchCollections (const Collection::List &collections)
void	setTagFetchScope (const TagFetchScope &fetchScope)
TagFetchScope &	tagFetchScope ()
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=nullptr)
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
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

Additional Inherited Members
Properties inherited from QObject
	objectName
Signals inherited from Akonadi::ItemSearchJob
void	itemsReceived (const Akonadi::Item::List &items)
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 Akonadi::Job
	ConnectionFailed
	ProtocolVersionMismatch
	Unknown
	UserCanceled
	UserError
Public Attributes inherited from KJob
	Bytes
	Directories
	Files
	Items
	Killable
	NoCapabilities
	Suspendable
	UnitsCount
Public Attributes inherited from QObject
typedef	QObjectList
Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &message)
virtual void	slotResult (KJob *job)
Protected Member Functions inherited from Akonadi::ItemSearchJob
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)
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)

Detailed Description

Job that searches for contacts in the Akonadi storage.

This job searches for contacts that match given search criteria and returns the list of contacts.

Examples:

// Search all contacts with email address tokoe@kde.org
Akonadi::ContactSearchJob *job = new Akonadi::ContactSearchJob();
job->setQuery( Akonadi::ContactSearchJob::Email, "tokoe@kde.org" );
connect( job, SIGNAL(result(KJob*)), this, SLOT(searchResult(KJob*)) );
 
...
 
MyClass::searchResult( KJob *job )
{
  Akonadi::ContactSearchJob *searchJob = qobject_cast<Akonadi::ContactSearchJob*>( job );
  const KContacts::Addressee::List contacts = searchJob->contacts();
  // do something with the contacts
}

// Search for all existing contacts
Akonadi::ContactSearchJob *job = new Akonadi::ContactSearchJob();
connect( job, SIGNAL(result(KJob*)), this, SLOT(searchResult(KJob*)) );
 
...
 
MyClass::searchResult( KJob *job )
{
  Akonadi::ContactSearchJob *searchJob = qobject_cast<Akonadi::ContactSearchJob*>( job );
  const KContacts::Addressee::List contacts = searchJob->contacts();
  // do something with the contacts
}

Author

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Since

4.4

Definition at line 68 of file contactsearchjob.h.

Member Enumeration Documentation

Criterion

enum Akonadi::ContactSearchJob::Criterion

Describes the criteria that can be searched for.

Enumerator
Name	The name of the contact.
Email	The email address of the contact.
NickName	The nickname of the contact.
NameOrEmail	The name or email address of the contact. Since 4.5
ContactUid	The global unique identifier of the contact. Since 4.5

Definition at line 88 of file contactsearchjob.h.

Match

enum Akonadi::ContactSearchJob::Match

Describes the type of pattern matching that shall be used.

Since

4.5

Enumerator
ExactMatch	The result must match exactly the pattern (case sensitive).
StartsWithMatch	The result must start with the pattern (case insensitive).
ContainsMatch	The result must contain the pattern (case insensitive).
ContainsWordBoundaryMatch	The result must contain a word starting with the pattern (case insensitive).

Definition at line 101 of file contactsearchjob.h.

Constructor & Destructor Documentation

ContactSearchJob()

ContactSearchJob::ContactSearchJob ( QObject * parent = nullptr )

explicit

Creates a new contact search job.

Parameters

parent

The parent object.

Definition at line 22 of file contactsearchjob.cpp.

~ContactSearchJob()

ContactSearchJob::~ContactSearchJob ( )

overridedefault

Destroys the contact search job.

Member Function Documentation

contacts()

KContacts::Addressee::List ContactSearchJob::contacts

(

)

const

Returns the contacts that matched the search criteria.

Definition at line 79 of file contactsearchjob.cpp.

setLimit()

void ContactSearchJob::setLimit

(

int

limit

)

Sets a limit on how many results will be returned by this search job.

This is useful in situation where for example only the first search result is needed anyway, setting a limit of 1 here will greatly reduce the resource usage during the search. This needs to be called before calling setQuery() to have an effect. By default, the number of results is unlimited.

Parameters

limit

the upper limit for number of search results

Definition at line 74 of file contactsearchjob.cpp.

setQuery()

void ContactSearchJob::setQuery	(	Criterion	criterion,
		const QString &	value,
		Match	match = ExactMatch )

Sets the criterion and value for the search with match.

Parameters

criterion	the query criterion to compare with
value	the value to match against
match	how to match the given value

Since

4.5

Definition at line 52 of file contactsearchjob.cpp.

---

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

• contactsearchjob.h
• contactsearchjob.cpp