Akonadi::ContactGroupSearchJob
#include <contactgroupsearchjob.h>

Public Types | |
enum | Criterion { Name } |
enum | Match { ExactMatch, StartsWithMatch, ContainsMatch } |
![]() | |
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 contact groups in the Akonadi storage.
This job searches for contact groups that match given search criteria and returns the list of contact groups.
- Since
- 4.4
Definition at line 49 of file contactgroupsearchjob.h.
Member Enumeration Documentation
◆ 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
Describes the type of pattern matching that shall be used.
- Since
- 4.5
Definition at line 78 of file contactgroupsearchjob.h.
Constructor & Destructor Documentation
◆ ContactGroupSearchJob()
|
explicit |
Creates a new contact group search job.
- Parameters
-
parent The parent object.
Definition at line 23 of file contactgroupsearchjob.cpp.
◆ ~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
- 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 71 of file contactgroupsearchjob.cpp.
◆ setQuery() [1/2]
Sets the criterion
and value
for the search.
Definition at line 40 of file contactgroupsearchjob.cpp.
◆ setQuery() [2/2]
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 59 of file contactgroupsearchjob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Wed Mar 22 2023 03:55:49 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.