Relativity.Services.Folder.IFolderManager

public interface IFolderManager : IDisposable

IFolderManager interface enables interaction with Folders.

Task<int> CreateSingleAsync(int workspaceArtifactID, Folder model)

Asynchronously creates an instance of Folder.

Asynchronously deletes any folders in the workspace which do not contain any documents or sub-folders with documents.

Asynchronously deletes any folders in the workspace which do not contain any documents or sub-folders with documents while reporting progress.

Task<FolderStatus> GetAccessStatusAsync(int workspaceArtifactID, int artifactID)

Returns folder status: folder exists, hasn't moved and has view permission.

Task<List<Folder>> GetChildrenAsync(int workspaceArtifactID, int parentId)

Returns all child elements of the specified Folder

Task<List<Folder>> GetFilteredFolderTreeAsync(int workspaceArtifactId, string searchCondition)

Asynchronously gets the tree of folders matching the search condition specified as a query string.

Task<List<Folder>> GetFolderTreeAsync(int workspaceArtifactId, List<int> expandedNodes)

Returns the folder structure with expanded nodes

Task<List<Folder>> GetFolderTreeAsync(int workspaceArtifactId, List<int> expandedNodes, int selectedFolderId)

Returns the folder structure with expanded nodes

Task<List<Folder>> GetFolderTreeWithAncestorsAsync(int workspaceArtifactID, List<int> artifactIDs)

Returns expanded folder structer

Task<List<FolderPath>> GetFullPathListAsync(int workspaceArtifactID, List<int> artifactIDs)

Retrieves the full path list.

Task<Folder> GetWorkspaceRootAsync(int workspaceArtifactID)

Retrieves a workplace root folder

Task<FolderMoveResultSet> MoveFolderAsync(int workspaceArtifactID, int artifactID, int destinationFolderID)

Moves an existing folder and its children, including subfolders and documents.

Task<FolderMoveResultSet> MoveFolderAsync(int workspaceArtifactID, int artifactID, int destinationFolderID, CancellationToken cancel)

Moves an existing folder and its children, including subfolders and documents.

Task<FolderMoveResultSet> MoveFolderAsync(int workspaceArtifactID, int artifactID, int destinationFolderID, IProgress<MoveProcessStateProgress> progress)

Moves an existing folder and its children, including subfolders and documents.

Task<FolderMoveResultSet> MoveFolderAsync(int workspaceArtifactID, int artifactID, int destinationFolderID, CancellationToken cancel, IProgress<MoveProcessStateProgress> progress)

Moves an existing folder and its children, including subfolders and documents.

Task<FolderResultSet> QueryAsync(int workspaceArtifactID, Query query)

Asynchronously query for a collection of Folder instances.

Task<FolderResultSet> QueryAsync(int workspaceArtifactID, Query query, int length)

Asynchronously query for a collection of Folder instances.

Task<FolderResultSet> QuerySubsetAsync(string queryToken, int start, int length)

Asynchronously query for a subset of a collection of Folder instances.

Task UpdateSingleAsync(int workspaceArtifactID, Folder model)

Asynchronously updates an instance of Folder.