IdtSearchManager interface enables interaction with Relativity dtSearch.
Namespace: Relativity.Services.Search
Assembly: Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The IdtSearchManager type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | CopySingleAsync |
Asynchronously copies an instance of dtSearch saved search.
|
| CreateSingleAsync |
Asynchronously creates an instance of saved dtSearch in a workspace.
|
| DeleteSingleAsync |
Asyncronously deletes an instance of saved dtSearch.
|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| GetAccessStatusAsync |
Asynchronously gets information about user's ability to access the saved search.
|
| GetEmailToLinkUrlAsync |
Asychronously returns the email link to a specified saved dtSearch.
|
| GetFieldsForCriteriaConditionAsync |
Asychronously returns all workspace fields available to the user that can be included in a saved search condition.
|
| GetFieldsForObjectCriteriaCollectionAsync |
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.
|
| GetFieldsForSearchResultViewAsync(Int32, Int32) |
Asychronously returns all workspace fields available to the user as the SearchResultViewFields.FieldsNotIncluded property. Use to populate the dtSearch.Fields property.
|
| GetFieldsForSearchResultViewAsync(Int32, Int32, Int32) |
Asychronously returns all fields included in the search as SearchResultViewFields.FieldsIncluded property. Use to populate the dtSearch.Fields property.
|
| GetReferencedSavedSearchesAsync |
Asychronously returns all referenced saved search artifact id's for a given saved search.
|
| GetSearchIncludesAsync |
Asychronously returns all relational fields available to the user in the workspace. Use to populate the dtSearch.Includes property.
|
| GetSearchIndexesAsync |
Asychronously returns all dtSearch indexes available to the user in the workspace. Use to populate the dtSearch.SearchIndexID property.
|
| GetSearchOwnersAsync |
Asychronously returns all users in the workspace with permissions to view saved searches. Use to populate the dtSearch.Owners property.
|
| MoveAsync(Int32, Int32, Int32) |
Moves an existing dtSearch. Specify the workspace, search, and destination folder by Artifact ID.
|
| MoveAsync(Int32, Int32, Int32, IProgress<MoveProcessStateProgress>) |
Moves an existing dtSearch. Specify the workspace, search, and destination folder by Artifact ID. Specify the MoveProgressState object to display the progress of the operation.
|
| MoveAsync(Int32, Int32, Int32, CancellationToken) |
Moves an existing dtSearch. Specify the workspace, search, and destination folder by Artifact ID. Specify the CancellationToken object to enable cancellation.
|
| MoveAsync(Int32, Int32, Int32, CancellationToken, IProgress<MoveProcessStateProgress>) |
Moves an existing dtSearch. Specify the workspace, search, and destination folder by Artifact ID. Specify the MoveProgressState and CancellationToken objects to display progress enable cancellation.
|
| QueryAsync(Int32, Query) |
Returns a result set of saved dtSearch objects matching the specified query.
|
| QueryAsync(Int32, Query, Int32) |
Returns a result set of saved dtSearch objects matching the specified query.
|
| QuerySubsetAsync |
Returns a subset of a result set of analytics objects matching the specified query token.
|
| ReadSingleAsync |
Asynchronously returns an instance of a saved dtSearch as a dtSearch object.
|
| UpdateSingleAsync |
Asynchronously updates an instance of a saved dtSearch.
|
See Also