StoreSearch

Object Hierarchy:

Description:

[ CCode ( type_id = "camel_store_search_get_type ()" ) ]
[ Version ( since = "3.58" ) ]
public class StoreSearch : Object

Search between multiple folders of one Store.

The StoreSearch allows to search between multiple folders of a single Store. It's primarily meant to be used by the search folders ( VeeFolder), but it can be used without it too.

It can run only one search at a time, using rebuild_sync.

The StoreSearch is not thread safe, it's meant to be created, used and freed from within the same thread only.

Namespace: Camel

Package: camel-1.2

Content:

Properties:

public Store store { get; construct; }
A Store this search works with.

Creation methods:

public StoreSearch (Store store)
Creates a new StoreSearch, which will operate on folders from the store.

Methods:

public void add_folder (Folder folder)
Adds the folder to the list of the folders to be searched in by the this.
public void add_match_index (StoreSearchIndex index)
Adds a match index index into the this.
public bool add_match_threads_items_sync (ref GenericArray<unowned StoreSearchThreadItem> inout_items, Cancellable? cancellable = null) throws Error
Adds StoreSearchThreadItem items into the location pointed to by the inout_items array.
public GenericArray<unowned string>? dup_additional_columns ()
Gets a new GenericArray with additional columns names previously set by the set_additional_columns, or null , when none had been set.
public unowned string? get_expression ()
Gets search expression previously set by the set_expression.
public bool get_items_sync (out GenericArray<unowned StoreSearchItem?> out_items, Cancellable? cancellable = null) throws Error
Reads all the items from all the set folders satisfying the set expression.
public MatchThreadsKind get_match_threads_kind (out FolderThreadFlags out_flags)
Gets the kind of the 'match-threads' search statement of the expression as recognized by the last rebuild_sync call, as one of the MatchThreadsKind values.
public unowned Store get_store ()
Gets a Store the this was constructed for.
public bool get_uids_sync (string folder_name, out GenericArray<unowned string> out_uids, Cancellable? cancellable = null) throws Error
Reads all the message UID-s from the folder folder_name satisfying the set expression.
public GenericArray<unowned Folder> list_folders ()
Lists the Folder -s the this searches in.
public GenericArray<unowned StoreSearchIndex> list_match_indexes ()
Lists all the match indexes added in the this.
public bool rebuild_sync (Cancellable? cancellable = null) throws Error
Rebuilds content of the this with the current search expression.
public StoreSearchIndex? ref_result_index ()
Gets a StoreSearchIndex being used as a search result index, previously set by set_result_index, or null, when none is set.
public void remove_folder (Folder folder)
Removes the folder from the list of the folders the this should search in.
public void remove_match_index (StoreSearchIndex index)
Removes the index from from list of the match indexes.
public void set_additional_columns (GenericArray<string>? colnames)
Sets what additional column names should be pre-read and provided in the get_items_sync result.
public void set_expression (string? expression)
Sets the search expression to be used to search the messages in the selected folders with.
public void set_result_index (StoreSearchIndex? index)
Sets, or unsets, a StoreSearchIndex to be used for the search.

Inherited Members:

All known members inherited from class GLib.Object