Akonadi::ContactGroupSearchJob Class Reference

#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 {   ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,   UserError = UserDefinedError + 42 }
typedef QList< Job * >	List

Public Member Functions
	ContactGroupSearchJob (QObject *parent=0)
	~ContactGroupSearchJob ()
KABC::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
AKONADI_DEPRECATED	ItemSearchJob (const QString &query, QObject *parent=0)
	ItemSearchJob (const SearchQuery &query, QObject *parent=0)
	~ItemSearchJob ()
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 AKONADI_DEPRECATED	setQuery (const QString &query)
void	setQuery (const SearchQuery &query)
void	setRecursive (bool recursive)
void	setRemoteSearchEnabled (bool enabled)
void	setSearchCollections (const Collection::List &collections)
Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)
virtual	~Job ()
virtual QString	errorString () const
void	start ()

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)
Static Public Member Functions inherited from Akonadi::ItemSearchJob
static AKONADI_DEPRECATED QUrl	akonadiItemIdUri ()
Protected Slots inherited from Akonadi::Job
virtual void	slotResult (KJob *job)
Protected Member Functions inherited from Akonadi::ItemSearchJob
virtual void	doHandleResponse (const QByteArray &tag, const QByteArray &data)
void	doStart ()
Protected Member Functions inherited from Akonadi::Job
virtual bool	addSubjob (KJob *job)
virtual bool	doKill ()
void	emitWriteFinished ()
virtual bool	removeSubjob (KJob *job)

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 KABC::ContactGroup::List contactGroups = searchJob->contactGroups();
  // do something with the contact groups
}

Author

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

Since

4.4

Definition at line 59 of file contactgroupsearchjob.h.

Member Enumeration Documentation

enum Akonadi::ContactGroupSearchJob::Criterion

Describes the criteria that can be searched for.

Enumerator
Name	The name of the contact group.

Definition at line 79 of file contactgroupsearchjob.h.

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 88 of file contactgroupsearchjob.h.

Constructor & Destructor Documentation

ContactGroupSearchJob::ContactGroupSearchJob ( QObject *  parent = 0 )

explicit

Creates a new contact group search job.

Parameters

parent

The parent object.

Definition at line 36 of file contactgroupsearchjob.cpp.

ContactGroupSearchJob::~ContactGroupSearchJob

(

)

Destroys the contact group search job.

Definition at line 50 of file contactgroupsearchjob.cpp.

Member Function Documentation

KABC::ContactGroup::List ContactGroupSearchJob::contactGroups

(

)

const

Returns the contact groups that matched the search criteria.

Definition at line 91 of file contactgroupsearchjob.cpp.

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

Note

this needs to be called before calling setQuery() to have an effect. By default, the number of results is unlimited.

Since

4.4.3

Definition at line 86 of file contactgroupsearchjob.cpp.

void ContactGroupSearchJob::setQuery	(	Criterion	criterion,
		const QString &	value
	)

Sets the criterion and value for the search.

Definition at line 55 of file contactgroupsearchjob.cpp.

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

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 74 of file contactgroupsearchjob.cpp.

---

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

• contactgroupsearchjob.h
• contactgroupsearchjob.cpp