Folder
Struct for a single folder.
| Full name | MFiles.Folder |
|---|---|
| Proto file | mfiles/structs.proto |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
type | FolderType | 1 | The type of the folder, for example FOLDER_TYPE_VIEW_FOLDER or FOLDER_TYPE_PROPERTY_FOLDER.Values: FOLDER_TYPE_UNKNOWN (0), FOLDER_TYPE_ANY_FOLDER (1), FOLDER_TYPE_VIEW_FOLDER (2), FOLDER_TYPE_PROPERTY_FOLDER (3), FOLDER_TYPE_TRADITIONAL_FOLDER (4), FOLDER_TYPE_SEARCH_FOLDER (5), FOLDER_TYPE_EXTERNAL_VIEW_FOLDER (6). |
data | FolderInfoUnion | 2 | Additional folder type -specific information as a union. |
Used by methods
- IRPCFolderUISettings.GetFolderUIState -- Gets the display settings of a folder location as a structure.
- IRPCFolderUISettings.SetFolderSelection -- Replaces the calling user's folder selection for one view level: the folders that the user always wants to see on a level whose listing is cut by the folder limit.
- IRPCFolderUISettings.SetFolderUIState -- Saves the display settings of a folder location from a structure, for the caller and optionally as the common settings.
- 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.GetPrefillProperties -- Gets the property values that a new object created in the given folder gets from that folder.
- IRPCSearch.SearchViewLevelFolders -- The search covers the folders that the listing of the level would show without the folder limit. The results can be saved as part of the user's folder selection. Fails with E_NOTIMPL when the feature is not enabled on the server.
Used in fields
ExternalViewWithParentLocation.parent_location-- The location of the External view.FolderArray.value-- Array of Folder structures.FolderContentDownloadUrlRequestData.folders-- Array of folders defining the folder contents to download.PropertyFolderWithParent.parent_location-- The location of the parent folders. Field with fid( 2 ) is reserved for legacy reasons and must not be re-used.TraditionalFolderWithParent.parent_location-- The location of the traditional folder.ViewLocation.parent_folder-- Array of folders describing the parent folder of the view. The first element of the array must be a view folder. Other elements, if any, are property folders.ViewWithParentLocation.parent_location-- The location of the view folder.GetFolderUIStateRequest.folder_location-- The path of folders from the vault root to the folder. Empty for the root.SetFolderUIStateRequest.folder_location-- The path of folders from the vault root to the folder. Empty for the root.SetFolderSelectionRequest.folder_location-- The path from the vault root to the parent of the level whose folders are selected: a view folder followed by property folders.GetFolderObjectsCountRequest.parent-- Describes the parent folder.GetPrefillPropertiesRequest.value-- Describes the parent folder.GetFolderContentsOrDeltaRequest.parent-- Describes the parent folder.GetFolderContentsRequest.path-- The folder location from the vault root, one Folder per level. Empty lists the vault root.SearchViewLevelFoldersRequest.folder_location-- The folder location, from the vault root to the parent of the level whose folders are searched. The same path that the listing of the level uses.