Akonadi::AgentSearchInterface Class Reference

#include <agentsearchinterface.h>

Public Member Functions
	AgentSearchInterface ()
virtual	~AgentSearchInterface ()
virtual void	addSearch (const QString &query, const QString &queryLanguage, const Akonadi::Collection &resultCollection)=0
virtual void	removeSearch (const Akonadi::Collection &resultCollection)=0

Detailed Description

An interface for agents (or resources) that support searching in their backend.

Inherit from this additionally to Akonadi::AgentBase (or Akonadi::ResourceBase) and implement its two pure virtual methods.

Make sure to add the Search capability to the agent desktop file.

Since

4.5

Definition at line 41 of file agentsearchinterface.h.

Constructor & Destructor Documentation

AgentSearchInterface::AgentSearchInterface

(

)

Creates a new agent search interface.

Definition at line 46 of file agentsearchinterface.cpp.

AgentSearchInterface::~AgentSearchInterface ( )

virtual

Destroys the agent search interface.

Definition at line 51 of file agentsearchinterface.cpp.

Member Function Documentation

virtual void Akonadi::AgentSearchInterface::addSearch ( const QString &  query, const QString &  queryLanguage, const Akonadi::Collection &  resultCollection  )

pure virtual

Adds a new search.

Parameters

query	The query string, using the language specified in queryLanguage
queryLanguage	The query language used for query
resultCollection	The destination collection for the search results. It's a virtual collection, results can be added/removed using Akonadi::LinkJob and Akonadi::UnlinkJob respectively.

virtual void Akonadi::AgentSearchInterface::removeSearch ( const Akonadi::Collection &  resultCollection )

pure virtual

Removes a previously added search.

Parameters

resultCollection

The result collection given in an previous addSearch() call. You do not need to take care of deleting results in there, the collection is just provided as a way to identify the search.

---

The documentation for this class was generated from the following files:

• agentsearchinterface.h
• agentsearchinterface.cpp