Akonadi::AbstractSearchPlugin

Search for usage in LXR

Akonadi::AbstractSearchPlugin Class Referenceabstract

#include <abstractsearchplugin.h>

Public Member Functions

virtual ~AbstractSearchPlugin ()=default
 
virtual QSet< qint64 > search (const QString &query, const QList< 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 26 of file abstractsearchplugin.h.

Constructor & Destructor Documentation

◆ ~AbstractSearchPlugin()

virtual Akonadi::AbstractSearchPlugin::~AbstractSearchPlugin ( )
virtualdefault

Destructor.

Member Function Documentation

◆ search()

virtual QSet< qint64 > Akonadi::AbstractSearchPlugin::search ( const QString & query,
const QList< 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-2024 The KDE developers.
Generated on Fri May 24 2024 11:58:18 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.