Akonadi::SearchCreateJob
#include <searchcreatejob.h>
Detailed Description
Job that creates a virtual/search collection in the Akonadi storage.
This job creates so called virtual or search collections, which don't contain real data, but references to items that match a given search query.
Definition at line 49 of file searchcreatejob.h.
Constructor & Destructor Documentation
◆ SearchCreateJob()
SearchCreateJob::SearchCreateJob | ( | const QString & | name, |
const SearchQuery & | searchQuery, | ||
QObject * | parent = nullptr ) |
Creates a search create job.
- Parameters
-
name The name of the search collection searchQuery The search query parent The parent object
- Since
- 4.13
Definition at line 54 of file searchcreatejob.cpp.
◆ ~SearchCreateJob()
|
override |
Destroys the search create job.
Definition at line 59 of file searchcreatejob.cpp.
Member Function Documentation
◆ createdCollection()
Akonadi::Collection SearchCreateJob::createdCollection | ( | ) | const |
Returns the newly created search collection once the job finished successfully.
Returns an invalid collection if the job has not yet finished or failed.
- Since
- 4.4
Definition at line 133 of file searchcreatejob.cpp.
◆ doHandleResponse()
|
overrideprotectedvirtual |
Reimplemented from Akonadi::Job.
Reimplemented from Akonadi::Job.
Definition at line 139 of file searchcreatejob.cpp.
◆ doStart()
|
overrideprotectedvirtual |
Reimplemented from Akonadi::Job.
Implements Akonadi::Job.
Definition at line 111 of file searchcreatejob.cpp.
◆ isRecursive()
bool SearchCreateJob::isRecursive | ( | ) | const |
Returns whether the search is recursive.
- Since
- 4.13
Definition at line 94 of file searchcreatejob.cpp.
◆ isRemoteSearchEnabled()
bool SearchCreateJob::isRemoteSearchEnabled | ( | ) | const |
Returns whether remote search is enabled.
- Since
- 4.13
Definition at line 106 of file searchcreatejob.cpp.
◆ searchCollections()
QList< Collection > SearchCreateJob::searchCollections | ( | ) | const |
Returns list of collections to search in.
- Since
- 4.13
Definition at line 70 of file searchcreatejob.cpp.
◆ searchMimeTypes()
QStringList SearchCreateJob::searchMimeTypes | ( | ) | const |
Returns list of mime types that search results can contain.
- Since
- 4.13
Definition at line 82 of file searchcreatejob.cpp.
◆ setRecursive()
void SearchCreateJob::setRecursive | ( | bool | recursive | ) |
Sets whether the search should recurse into collections.
When set to true, all child collections of the specific collections will be search recursively.
- Parameters
-
recursive Whether to search recursively
- Since
- 4.13
Definition at line 87 of file searchcreatejob.cpp.
◆ setRemoteSearchEnabled()
void SearchCreateJob::setRemoteSearchEnabled | ( | bool | enabled | ) |
Sets whether resources should be queried too.
When set to true, Akonadi will search local indexed items and will also query resources that support server-side search, to forward the query to remote storage (for example using SEARCH feature on IMAP servers) and merge their results with results from local index.
This is useful especially when searching resources, that don't fetch full payload by default, for example the IMAP resource, which only fetches headers by default and the body is fetched on demand, which means that emails that were not yet fully fetched cannot be indexed in local index, and thus cannot be searched. With remote search, even those emails can be included in search results.
This feature is disabled by default.
- Parameters
-
enabled Whether remote search is enabled
- Since
- 4.13
Definition at line 99 of file searchcreatejob.cpp.
◆ setSearchCollections()
void SearchCreateJob::setSearchCollections | ( | const QList< Collection > & | collections | ) |
Sets list of collections to search in.
When an empty list is set (default value), the search will contain results from all collections that contain given mime types.
- Parameters
-
collections Collections to search in, or an empty list to search all
- Since
- 4.13
Definition at line 63 of file searchcreatejob.cpp.
◆ setSearchMimeTypes()
void SearchCreateJob::setSearchMimeTypes | ( | const QStringList & | mimeTypes | ) |
Sets list of mime types of items that search results can contain.
- Parameters
-
mimeTypes Mime types of items to include in search
- Since
- 4.13
Definition at line 75 of file searchcreatejob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:13:39 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.