SearchTarget
Search options.
Leave unset to search the vault's default index in SEARCH_MODE_DEFAULT, where the full-text
search engine is used only for searches with a full-text (any-field) condition.
| Full name | MFiles.SearchTarget |
|---|---|
| Proto file | mfiles/structs.proto |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
index | string | 1 | The name of the search index to use. Empty uses the vault's default index. An unknown name fails with "Target index is not available." |
mode | SearchMode | 2 | Whether to prefer, require or avoid the full-text search engine. See SearchMode.Values: SEARCH_MODE_DEFAULT (0), SEARCH_MODE_FAVOR_FULL_TEXT_SEARCH (1), SEARCH_MODE_REQUIRE_FULL_TEXT_SEARCH (2), SEARCH_MODE_REQUIRE_DATABASE_SEARCH (3). |
search_master_storage | bool | 3 | True to also search objects kept in Master Storage, where the vault supports it. |
continuation_token | string | 4 | Continuation token for paging results from Master Storage. SearchObjects does not support it and fails with "Continuation token is not supported." when it is set together with search_master_storage. |
Used by methods
- IRPCSearch.GetFacetValues -- Retrieves the facet values for the documents that satisfy the specified search conditions.
- IRPCSearch.GetFolderContents -- Lists the contents of a view or a view level: subviews, grouping folders and objects.
- IRPCSearch.GetFolderContentsOrDelta -- Gets the contents of the specified folder, or a delta that indicates changes to document vault data since the logical timestamp known by the caller.
- IRPCSearch.GetFolderObjectsCount -- Gets the count of objects in the specified folder.
- IRPCSearch.GetObjectCountInSearch -- Counts the objects that match the given conditions without returning them.
- IRPCSearch.GetSearchHits -- Finds the words of a text that a full-text search condition matches, for hit highlighting.
- IRPCSearch.SearchObjects -- Searches the vault for objects that match the given conditions.
Used in fields
GetFolderObjectsCountRequest.search_options-- Search options.GetFacetValuesRequest.search_options-- Search options.GetSearchHitsRequest.search_options-- Search options.GetObjectCountInSearchRequest.search_options-- The search index and search mode. Leave unset for the vault's default index.SearchObjectsRequest.target-- The search index and search mode. Leave unset to use the vault's default index andSEARCH_MODE_DEFAULT. An unknown index name fails with "Target index is not available."GetFolderContentsOrDeltaRequest.search_options-- Search options.GetFolderContentsRequest.target-- Search options.