Akonadi::AbstractSearchPlugin

Akonadi::AbstractSearchPlugin Class Referenceabstract

#include <abstractsearchplugin.h>

Public Member Functions

virtual ~AbstractSearchPlugin ()
 
virtual QSet< qint64 > search (const QString &query, const QVector< qint64 > &collections, const QStringList &mimeTypes)=0
 

Detailed Description

3rd party applications can install a search plugin for Akonadi server to provide access to their search capability.

When the server performs a search, it will send the query to all available search plugins and merge the results.

Since
1.12

Definition at line 41 of file abstractsearchplugin.h.

Constructor & Destructor Documentation

virtual Akonadi::AbstractSearchPlugin::~AbstractSearchPlugin ( )
inlinevirtual

Destructor.

Definition at line 48 of file abstractsearchplugin.h.

Member Function Documentation

virtual QSet<qint64> Akonadi::AbstractSearchPlugin::search ( const QString query,
const QVector< qint64 > &  collections,
const QStringList mimeTypes 
)
pure virtual

Reimplement this method to provide the actual search capability.

The implementation can block.

Parameters
querySearch query to execute.
Returns
List of Akonadi Item IDs referring to items that are matching the query.

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun May 31 2020 22:46:24 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.