Akonadi::ContactSearchJob
#include <contactsearchjob.h>

Public Types | |
enum | Criterion { Name, Email, NickName, NameOrEmail, ContactUid } |
enum | Match { ExactMatch, StartsWithMatch, ContainsMatch, ContainsWordBoundaryMatch } |
![]() | |
enum | Error |
typedef QList< Job * > | List |
Additional Inherited Members | |
![]() | |
void | itemsReceived (const Akonadi::Item::List &items) |
![]() | |
void | aboutToStart (Akonadi::Job *job) |
void | writeFinished (Akonadi::Job *job) |
![]() | |
ConnectionFailed | |
ProtocolVersionMismatch | |
Unknown | |
UserCanceled | |
UserError | |
![]() | |
bool | doHandleResponse (qint64 tag, const Protocol::CommandPtr &response) override |
void | doStart () override |
![]() | |
bool | addSubjob (KJob *job) override |
bool | doKill () override |
void | emitWriteFinished () |
bool | removeSubjob (KJob *job) override |
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:
- Since
- 4.4
Definition at line 68 of file contactsearchjob.h.
Member Enumeration Documentation
◆ Criterion
Describes the criteria that can be searched for.
Definition at line 88 of file contactsearchjob.h.
◆ Match
Describes the type of pattern matching that shall be used.
- Since
- 4.5
Definition at line 101 of file contactsearchjob.h.
Constructor & Destructor Documentation
◆ ContactSearchJob()
|
explicit |
Creates a new contact search job.
- Parameters
-
parent The parent object.
Definition at line 22 of file contactsearchjob.cpp.
◆ ~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:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Nov 28 2023 03:51:43 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.