Relativity.Services.Interfaces.Workspace.IWorkspaceManager

public interface IWorkspaceManager : IDisposable

Exposes the methods for working with workspace objects.

Documentation

Task<WorkspaceResponse> CreateAsync(WorkspaceRequest workspaceRequest)

Adds a workspace to Relativity.

Task<WorkspaceResponse> CreateAsync(WorkspaceRequest workspaceRequest, IProgress<ProgressReport> progress)

Adds a workspace to Relativity.

Task<WorkspaceResponse> CreateAsync(WorkspaceRequest workspaceRequest, CancellationToken cancel)

Adds a workspace to Relativity.

Task<WorkspaceResponse> CreateAsync(WorkspaceRequest workspaceRequest, CancellationToken cancel, IProgress<ProgressReport> progress)

Adds a workspace to Relativity.

Task DeleteAsync(int workspaceID)

Deletes a workspace.

Task DeleteAsync(int workspaceID, IProgress<ProgressReport> progress)

Deletes a workspace.

Task DeleteAsync(int workspaceID, CancellationToken cancel)

Deletes a workspace.

Task DeleteAsync(int workspaceID, CancellationToken cancel, IProgress<ProgressReport> progress)

Deletes a workspace.

Task<string> GetDefaultDownloadHandlerURLAsync()

Get Default Download Handler URL.

Task<List<DisplayableObjectIdentifier>> GetEligibleAzureCredentialsAsync(int resourcePoolID)

Retrieves a list of azure credentials that are eligible for a workspace's Azure Credentials property.

Task<List<DisplayableObjectIdentifier>> GetEligibleAzureFileSystemCredentialsAsync(int resourcePoolID)

Retrieves a list of azure file system credentials that are eligible for a workspace's Azure File System Credentials property.

Task<List<DisplayableObjectIdentifier>> GetEligibleCacheLocationsAsync(int resourcePoolID)

Retrieves a list of cache locations that are eligible for a workspace's DefaultCacheLocation property.

Task<List<DisplayableObjectIdentifier>> GetEligibleFileRepositoriesAsync(int resourcePoolID)

Retrieves a list of file repository servers that are eligible for a workspace's DefaultFileRepository and DataGridFileRepository properties.

Task<List<DisplayableObjectIdentifier>> GetEligibleResourcePoolsAsync()

Retrieves a list of resource pools that are eligible for a workspace's ResourcePool property.

Task<SqlFullTextLanguageOptions> GetEligibleSqlFullTextLanguagesAsync()

Retrieves a list of eligible languages for workspace's SQLFullTextLanguage property.

Task<List<DisplayableObjectIdentifier>> GetEligibleSqlServersAsync(int resourcePoolID)

Retrieves a list of SQL servers that are eligible for a workspace's SqlServer property.

Task<List<DisplayableObjectIdentifier>> GetEligibleStatusesAsync()

Retrieves a list of choices that are eligible to for a workspace's Status property.

Task<Meta> GetMetaAsync()

Get Meta Information for workspace creation.

Task<WorkspaceSummary> GetWorkspaceSummaryAsync(int workspaceID)

Retrieves statistics about the workspace.

Task MoveToColdStorageAsync(int workspaceID)

Migrates a workspace to the Cold Storage

Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length)

Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length, CancellationToken cancel)

Task<QueryResultSlim> QueryEligibleClientsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length)

Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length, CancellationToken cancel)

Task<QueryResultSlim> QueryEligibleGroupsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length)

Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length, CancellationToken cancel)

Task<QueryResultSlim> QueryEligibleMattersAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID)

Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID, CancellationToken cancel)

Task<QueryResultSlim> QueryEligibleSavedSearchesAsync(QueryRequest request, int start, int length, int workspaceID, CancellationToken cancel, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length)

Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length, CancellationToken cancel)

Task<QueryResultSlim> QueryEligibleTemplatesAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryWorkspaceByGroupAsync(QueryRequest request, int start, int length, int groupID)

Task<QueryResultSlim> QueryWorkspaceByGroupAsync(QueryRequest request, int start, int length, int groupID, IProgress<ProgressReport> progress)

Task<QueryResultSlim> QueryWorkspaceByGroupAsync(QueryRequest request, int start, int length, int groupID, CancellationToken cancel)

Task<QueryResultSlim> QueryWorkspaceByGroupAsync(QueryRequest request, int start, int length, int groupID, CancellationToken cancel, IProgress<ProgressReport> progress)

Task<WorkspaceResponse> ReadAsync(int workspaceID)

Retrieves all metadata for a workspace.

Task<WorkspaceResponse> ReadAsync(int workspaceID, bool includeMetadata, bool includeActions)

Retrieves advanced metadata for a workspace, including information about additional actions eligible.

Task RetryFailedCreateEventHandlersAsync(int workspaceID)

Retry Failed Create Event Handlers for specified workspace.

Task<WorkspaceResponse> UpdateAsync(int workspaceID, WorkspaceRequest workspaceRequest)

Modifies the properties of a workspace.

Task<WorkspaceResponse> UpdateAsync(int workspaceID, WorkspaceRequest workspaceRequest, DateTime lastModifiedOn)

Modifies the properties of a workspace.