Akonadi::ContactGroupSearchJob

Akonadi
ContactGroupSearchJob

#include <contactgroupsearchjob.h>

Inheritance diagram for Akonadi::ContactGroupSearchJob:

Public Types
enum	Criterion { Name }

enum	Match { ExactMatch, StartsWithMatch, ContainsMatch }

Public Types inherited from Akonadi::Job
enum	Error

typedef QList< Job * >	List

Public Member Functions
	ContactGroupSearchJob (QObject *parent=nullptr)

	~ContactGroupSearchJob () override

KContacts::ContactGroup::List	contactGroups () const

void	setLimit (int limit)

void	setQuery (Criterion criterion, const QString &value)

void	setQuery (Criterion criterion, const QString &value, Match match)

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

Additional Inherited Members
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)

Public Attributes inherited from Akonadi::Job
	ConnectionFailed

	ProtocolVersionMismatch

	Unknown

	UserCanceled

	UserError

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

Detailed Description

Job that searches for contact groups in the Akonadi storage.

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

Akonadi::ContactGroupSearchJob *job = new Akonadi::ContactGroupSearchJob();
job->setQuery( Akonadi::ContactGroupSearchJob::Name, "Family Members" );
connect( job, SIGNAL(result(KJob*)), this, SLOT(searchResult(KJob*)) );
 
...
 
MyClass::searchResult( KJob *job )
{
  Akonadi::ContactGroupSearchJob *searchJob = qobject_cast<Akonadi::ContactGroupSearchJob*>( job );
  const KContacts::ContactGroup::List contactGroups = searchJob->contactGroups();
  // do something with the contact groups
}

Author: Tobias Koenig tokoe[email protected]@kde[email protected].org

Since: 4.4

Definition at line 49 of file contactgroupsearchjob.h.

Member Enumeration Documentation

◆ Criterion

enum Akonadi::ContactGroupSearchJob::Criterion

Describes the criteria that can be searched for.

Enumerator
Name	The name of the contact group.

Definition at line 69 of file contactgroupsearchjob.h.

◆ Match

enum Akonadi::ContactGroupSearchJob::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).

Definition at line 78 of file contactgroupsearchjob.h.

Constructor & Destructor Documentation

◆ ContactGroupSearchJob()

ContactGroupSearchJob::ContactGroupSearchJob ( QObject * parent = nullptr )

explicit

Creates a new contact group search job.

Parameters

parent The parent object.

Definition at line 23 of file contactgroupsearchjob.cpp.

◆ ~ContactGroupSearchJob()

ContactGroupSearchJob::~ContactGroupSearchJob ( )

overridedefault

Destroys the contact group search job.

Member Function Documentation

◆ contactGroups()

KContacts::ContactGroup::List ContactGroupSearchJob::contactGroups ( ) const

Returns the contact groups that matched the search criteria.

Definition at line 76 of file contactgroupsearchjob.cpp.

◆ setLimit()

void ContactGroupSearchJob::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.

Parameters

limit the limit to set