SearchObjects

Searches the document vault for objects that match the given conditions.

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results = await shellUI.Vault.SearchOperations.SearchObjects({
  call_importance: 2 /* Enum: CallImportance */,
  target: {
    index: "<!< Specifies the index to use on the server.>",
    mode: 3 /* Enum: SearchMode */,
  },
  conditions: [] /* Array of SearchConditionArray */,
  limit: 0,
  timeout_in_seconds: 0,
  sorting: {
    rules: {
      values: [] /* Array of SortRule */,
    },
    options: {
      all: false,
      allow_resorting_to_default_sort: false,
    },
  },
});

Message

Name	Description	Type
call_importance	The importance level of this call. Typically eciNormal.	CallImportance
target	Search options.	SearchTarget
conditions	An array of search condition arrays as JSON (Represented by CMF_SearchConditionArray struct). Inside search condition arrays, search conditions are combined with the AND operator. Search condition arrays are combined with the OR operator.	SearchConditionArray[]
limit	The maximum number of results to search for. 0 for infinite. 500 items is currently the default.	number
timeout_in_seconds	Timeout for the search in seconds. 0 for infinite wait. Default is 60 seconds.	number
sorting	If not empty, specifies how search results are being sorted.	SearchResultsSorting

Return type

Name	Description	Type
results	Results as JSON array (Represented by CMF_SearchResultsItem struct).	SearchResultsItem[]
has_more_results	Are there more results?	boolean
search_execution_info	Additional information about the completed search operation.	SearchOutputInfo

Example

{
  "results": [] /* Array of SearchResultsItem */,
  "has_more_results": false,
  "search_execution_info": {
    "processing_time_at_engine_in_milliseconds": 0,
    "processing_time_at_engine_from_mfserver_in_milliseconds": 0,
    "processing_time_at_mfserver_in_milliseconds": 0,
    "processing_time_at_mfserver_from_client_in_milliseconds": 0
  }
}