Akonadi::Search::PIM::ContactQuery

Search for usage in LXR

Akonadi::Search::PIM::ContactQuery Class Reference

#include <contactquery.h>

Inheritance diagram for Akonadi::Search::PIM::ContactQuery:

Public Types

enum  MatchCriteria { ExactMatch , StartsWithMatch }
 

Public Member Functions

ResultIterator exec () override
 
int limit () const
 
void match (const QString &str)
 
MatchCriteria matchCriteria () const
 
void matchEmail (const QString &email)
 
void matchName (const QString &name)
 
void matchNickname (const QString &nick)
 
void matchUID (const QString &uid)
 
void setLimit (int limit)
 
void setMatchCriteria (MatchCriteria m)
 
- Public Member Functions inherited from Akonadi::Search::PIM::Query

Additional Inherited Members

- Static Public Member Functions inherited from Akonadi::Search::PIM::Query
static QString defaultLocation (const QString &dbName)
 
static QueryfromJSON (const QByteArray &json)
 

Detailed Description

Query for a list of contacts matching a criteria.

Definition at line 29 of file contactquery.h.

Member Enumeration Documentation

◆ MatchCriteria

enum Akonadi::Search::PIM::ContactQuery::MatchCriteria

Definition at line 41 of file contactquery.h.

Constructor & Destructor Documentation

◆ ContactQuery()

ContactQuery::ContactQuery ( )

Definition at line 34 of file contactquery.cpp.

Member Function Documentation

◆ exec()

ResultIterator ContactQuery::exec ( )
nodiscardoverridevirtual

Implements Akonadi::Search::PIM::Query.

Definition at line 88 of file contactquery.cpp.

◆ limit()

int ContactQuery::limit ( ) const
nodiscard

Definition at line 68 of file contactquery.cpp.

◆ match()

void ContactQuery::match ( const QString & str)

Definition at line 63 of file contactquery.cpp.

◆ matchCriteria()

ContactQuery::MatchCriteria ContactQuery::matchCriteria ( ) const
nodiscard

Definition at line 78 of file contactquery.cpp.

◆ matchEmail()

void ContactQuery::matchEmail ( const QString & email)

Definition at line 53 of file contactquery.cpp.

◆ matchName()

void ContactQuery::matchName ( const QString & name)

Definition at line 43 of file contactquery.cpp.

◆ matchNickname()

void ContactQuery::matchNickname ( const QString & nick)

Definition at line 48 of file contactquery.cpp.

◆ matchUID()

void ContactQuery::matchUID ( const QString & uid)

Definition at line 58 of file contactquery.cpp.

◆ setLimit()

void ContactQuery::setLimit ( int limit)

Definition at line 73 of file contactquery.cpp.

◆ setMatchCriteria()

void ContactQuery::setMatchCriteria ( ContactQuery::MatchCriteria m)

Definition at line 83 of file contactquery.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:10:52 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.