• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.9.1 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • ContactGroupSearchJob
Public Types | Public Member Functions
Akonadi::ContactGroupSearchJob Class Reference

#include <contactgroupsearchjob.h>

Inheritance diagram for Akonadi::ContactGroupSearchJob:
Inheritance graph
[legend]

List of all members.

Public Types

enum  Criterion { Name }
enum  Match { ExactMatch, StartsWithMatch, ContainsMatch }

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
 ItemSearchJob (const QString &query, QObject *parent=0)
 ~ItemSearchJob ()
ItemFetchScope & fetchScope ()
Item::List items () const
void setFetchScope (const ItemFetchScope &fetchScope)
void setQuery (const QString &query)
- 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 QUrl akonadiItemIdUri ()
- 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 89 of file contactgroupsearchjob.h.


Constructor & Destructor Documentation

Akonadi::ContactGroupSearchJob::ContactGroupSearchJob ( QObject *  parent = 0)
explicit

Creates a new contact group search job.

Parameters:
parentThe parent object.
Akonadi::ContactGroupSearchJob::~ContactGroupSearchJob ( )

Destroys the contact group search job.


Member Function Documentation

KABC::ContactGroup::List Akonadi::ContactGroupSearchJob::contactGroups ( ) const

Returns the contact groups that matched the search criteria.

void Akonadi::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 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.

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

Sets the criterion and value for the search.

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

Sets the criterion and value for the search with match.

Since:
4.5

The documentation for this class was generated from the following file:
  • contactgroupsearchjob.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Sep 24 2012 09:06:30 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.9.1 API Reference

Skip menu "kdepimlibs-4.9.1 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal