GetFolderContents

Gets the contents of the specified folder.

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results = await shellUI.Vault.SearchOperations.GetFolderContents({
  call_importance: 2 /* Enum: CallImportance */,
  target: {
    index: "<!< Specifies the index to use on the server.>",
    mode: 3 /* Enum: SearchMode */,
  },
  path: [] /* Array of Folder */,
  limit: 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
path	Describes the parent folder as JSON array (Represented by CMF_FolderArray struct).	Folder[]
limit	Requested max results. If this is 0, it should be ignored.	number
sorting	If not empty, specifies how search results are being sorted.	SearchResultsSorting

Return type

Name	Description	Type
view_folders	Resulting views as JSON array (Represented by CMF_View struct).	View[]
property_folders	Resulting property folders as JSON array (Represented by CMF_TypedValue struct).	TypedValue[]
traditional_folders	Resulting traditional folders as JSON array (Represented by CMF_Lookup struct).	Lookup[]
objects	Resulting objects as JSON array (Represented by CMF_SearchResultsItem struct).	SearchResultsItem[]
external_repository_folders	External views as JSON array.	ExternalView[]
has_more_property_folders	Are there more property folders?	boolean
has_more_objects	Are there more objects?	boolean
has_more_external_repository_folders	Are there more external view folders?	boolean
search_execution_info	Additional information about the completed search operation.	SearchOutputInfo

Example

{
  "view_folders": [] /* Array of View */,
  "property_folders": [] /* Array of TypedValue */,
  "traditional_folders": [] /* Array of Lookup */,
  "objects": [] /* Array of SearchResultsItem */,
  "external_repository_folders": [] /* Array of ExternalView */,
  "has_more_property_folders": false,
  "has_more_objects": false,
  "has_more_external_repository_folders": 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
  }
}