IFolderManager interface enables interaction with Folders.
Namespace: Relativity.Services.Folder
Assembly: Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The IFolderManager type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | CreateSingleAsync |
Asynchronously creates an instance of Folder.
|
| DeleteUnusedFoldersAsync(Int32) |
Asynchronously deletes any folders in the workspace which do not contain any documents or sub-folders with documents.
|
| DeleteUnusedFoldersAsync(Int32, IProgress<ProcessStateProgress>) |
Asynchronously deletes any folders in the workspace which do not contain any documents or sub-folders with documents while reporting progress.
|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| GetAccessStatusAsync |
Returns folder status: folder exists, hasn't moved and has view permission.
|
| GetChildrenAsync |
Returns all child elements of the specified Folder
|
| GetFilteredFolderTreeAsync |
Asynchronously gets the tree of folders matching the search condition specified as a query string.
|
| GetFolderTreeAsync(Int32, List<Int32>) |
Returns the folder structure with expanded nodes
|
| GetFolderTreeAsync(Int32, List<Int32>, Int32) |
Returns the folder structure with expanded nodes
|
| GetFolderTreeWithAncestorsAsync |
Returns expanded folder structer
|
| GetFullPathListAsync |
Retrieves the full path list.
|
| GetWorkspaceRootAsync |
Retrieves a workplace root folder
|
| MoveFolderAsync(Int32, Int32, Int32) |
Moves an existing folder and its children, including subfolders and documents.
|
| MoveFolderAsync(Int32, Int32, Int32, IProgress<MoveProcessStateProgress>) |
Moves an existing folder and its children, including subfolders and documents.
|
| MoveFolderAsync(Int32, Int32, Int32, CancellationToken) |
Moves an existing folder and its children, including subfolders and documents.
|
| MoveFolderAsync(Int32, Int32, Int32, CancellationToken, IProgress<MoveProcessStateProgress>) |
Moves an existing folder and its children, including subfolders and documents.
|
| QueryAsync(Int32, Query) |
Asynchronously query for a collection of Folder instances.
|
| QueryAsync(Int32, Query, Int32) |
Asynchronously query for a collection of Folder instances.
|
| QuerySubsetAsync |
Asynchronously query for a subset of a collection of Folder instances.
|
| UpdateSingleAsync |
Asynchronously updates an instance of Folder.
|
See Also