Job that searches for contacts in the Akonadi storage. More...
#include <contactsearchjob.h>
Inherits ItemSearchJob.
Public Types | |
enum | Criterion { Name, Email, NickName, NameOrEmail, ContactUid } |
enum | Match { ExactMatch, StartsWithMatch, ContainsMatch } |
Public Member Functions | |
ContactSearchJob (QObject *parent=0) | |
~ContactSearchJob () | |
KABC::Addressee::List | contacts () const |
void | setLimit (int limit) |
void | setQuery (Criterion criterion, const QString &value) |
void | setQuery (Criterion criterion, const QString &value, Match match) |
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 KABC::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 KABC::Addressee::List contacts = searchJob->contacts(); // do something with the contacts }
- Since:
- 4.4
Definition at line 79 of file contactsearchjob.h.
Member Enumeration Documentation
Describes the criteria that can be searched for.
- Enumerator:
Definition at line 99 of file contactsearchjob.h.
Describes the type of pattern matching that shall be used.
- Since:
- 4.5
- Enumerator:
Definition at line 113 of file contactsearchjob.h.
Constructor & Destructor Documentation
ContactSearchJob::ContactSearchJob | ( | QObject * | parent = 0 | ) | [explicit] |
Creates a new contact search job.
- Parameters:
-
parent The parent object.
Definition at line 34 of file contactsearchjob.cpp.
ContactSearchJob::~ContactSearchJob | ( | ) |
Destroys the contact search job.
Definition at line 58 of file contactsearchjob.cpp.
Member Function Documentation
KABC::Addressee::List ContactSearchJob::contacts | ( | ) | const |
Returns the contacts that matched the search criteria.
Definition at line 604 of file contactsearchjob.cpp.
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 of Nepomuk during the search.
This needs to be called before calling setQuery() to have an effect. By default, the number of results is unlimited.
Definition at line 599 of file contactsearchjob.cpp.
void ContactSearchJob::setQuery | ( | Criterion | criterion, |
const QString & | value | ||
) |
Sets the criterion
and value
for the search.
- Note:
- ExactMatch is used for the matching.
- Todo:
- Merge with the method below in KDE5
Definition at line 63 of file contactsearchjob.cpp.
Sets the criterion
and value
for the search with match
.
- Since:
- 4.5
Definition at line 68 of file contactsearchjob.cpp.
The documentation for this class was generated from the following files: