IAnalyticsSearchManager Interface

Relativity Services API
IAnalyticsSearchManager interface enables interaction with Relativity analytics search.

Namespace:  Relativity.Services.Search
Assembly:  Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public interface IAnalyticsSearchManager : IDisposable

The IAnalyticsSearchManager type exposes the following members.

Methods

  NameDescription
Public methodCopySingleAsync
Asynchronously copies an instance of analytics saved search.
Public methodCreateSingleAsync
Asynchronously creates an instance of analytics saved search in a workspace.
Public methodDeleteSingleAsync
Asyncronously deletes an instance of analytics saved search.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodGetAccessStatusAsync
Asynchronously gets information about user's ability to access the saved search.
Public methodGetEmailToLinkUrlAsync
Asychronously returns the email link to a specified analytics saved search.
Public methodGetFieldsForCriteriaConditionAsync
Asychronously returns all workspace fields available to the user that can be included in a saved search condition.
Public methodGetFieldsForObjectCriteriaCollectionAsync
Asychronously returns all workspace fields available to the user that can be specified as a subcondition for a given field in a saved search condition. Use to populate field values for batch and multi-object conditions.
Public methodGetFieldsForSearchResultViewAsync(Int32, Int32)
Asychronously returns all workspace fields available to the user as the SearchResultViewFields.FieldsNotIncluded property. Use to populate the AnalyticsSearch.Fields property.
Public methodGetFieldsForSearchResultViewAsync(Int32, Int32, Int32)
Asychronously returns all fields included in the search as SearchResultViewFields.FieldsIncluded property. Use to populate the AnalyticsSearch.Fields property.
Public methodGetReferencedSavedSearchesAsync
Asychronously returns all referenced saved search artifact id's for a given saved search.
Public methodGetSearchIncludesAsync
Asychronously returns all relational fields available to the user in the workspace. Use to populate the AnalyticsSearch.Includes property.
Public methodGetSearchIndexesAsync
Asychronously returns all analytics indexes available to the user in the workspace. Use to populate the AnalyticsSearch.SearchIndexID property.
Public methodGetSearchOwnersAsync
Asychronously returns all users in the workspace with permissions to view saved searches. Use to populate the AnalyticsSearch.Owners property.
Public methodMoveAsync(Int32, Int32, Int32)
Moves an existing analytics saved search. Specify the workspace, search, and destination folder by Artifact ID.
Public methodMoveAsync(Int32, Int32, Int32, IProgress<MoveProcessStateProgress>)
Moves an existing analytics saved search. Specify the workspace, search, and destination folder by Artifact ID. Specify the MoveProgressState object to display the progress of the operation.
Public methodMoveAsync(Int32, Int32, Int32, CancellationToken)
Moves an existing analytics saved search. Specify the workspace, search, and destination folder by Artifact ID. Specify the CancellationToken object to enable cancellation.
Public methodMoveAsync(Int32, Int32, Int32, CancellationToken, IProgress<MoveProcessStateProgress>)
Moves an existing analytics saved search. Specify the workspace, search, and destination folder by Artifact ID. Specify the MoveProgressState and CancellationToken objects to display progress and enable cancellation.
Public methodQueryAsync(Int32, Query)
Returns a result set of analytics saved search objects matching the specified query.
Public methodQueryAsync(Int32, Query, Int32)
Returns a result set of analytics saved search objects matching the specified query.
Public methodQuerySubsetAsync
Returns a subset of a result set of analytics objects matching the specified query token.
Public methodReadSingleAsync
Asynchronously returns an instance of an analytics saved search as an AnalyticsSearch object.
Public methodUpdateSingleAsync
Asynchronously updates an instance of a analytics saved search.
Top
See Also

Reference