<PackageReference Include="Relativity.Server.Services.Interfaces.SDK" Version="5002.1.0" />

Relativity.Services.Interfaces.Choice.IChoiceManager

public interface IChoiceManager : IDisposable
Exposes methods for creating, reading, updating, and deleting choices, as well as various helper methods.
Task<int> CreateAsync(int workspaceID, ChoiceRequest choiceRequest)

Adds a choice to Relativity.

Task<MassCreateChoiceResponse> CreateAsync(int workspaceID, MassCreateChoiceRequest massCreateChoiceRequest)

Adds a list of choices to Relativity throught a bulk operation using choices names and a default information object.

Task DeleteAsync(int workspaceID, int choiceID)

Delete a choice. If the choice has children choices an error is thrown

Task DeleteAsync(int workspaceID, Guid choiceGuid)

Delete a choice. If the choice has children choices an error is thrown

Task<MassActionChoiceResponse> DeleteAsync(int workspaceID, MassDeleteChoiceRequest massDeleteRequest)

Performs a mass delete operation for a list of choice identifiers.

Task<List<DisplayableObjectIdentifier>> GetAvailableParentsListAsync(int workspaceID, ObjectIdentifier fieldIdentifier)

Retrieve the list of available parent choices in a field.

Task<List<DisplayableObjectIdentifier>> GetAvailableParentsListAsync(int workspaceID, int choiceID)

Retrieve the list of available parent choices for a choice

Task<List<DisplayableObjectIdentifier>> GetAvailableParentsListAsync(int workspaceID, Guid choiceGuid)

Retrieve the list of available parent choices for a choice.

Task<List<NameIDPair>> GetColorsListAsync(int workspaceID)

Retrieve the list of available colors.

Task<MassActionChoiceResponse> MoveAsync(int workspaceID, int fieldID, ObjectIdentifier[] choiceObjectIdentifiers, ChoiceMoveTypeEnum moveListTo)

Updates the order of a set of choices to locate them in the beginning or the end of the choices in a field.

Task<MassActionChoiceResponse> MoveAsync(int workspaceID, int fieldID, ObjectIdentifier[] choiceObjectIdentifiers, ObjectIdentifier choiceID)

Updates the order of a set of choices to locate them after an specific choice.

Task<ChoiceResponse> ReadAsync(int workspaceID, int choiceID)

Retrieves basic metadata for a choice, including its name, field, and other properties.

Task<ChoiceResponse> ReadAsync(int workspaceID, Guid choiceGuid)

Retrieves basic metadata for a choice, including its name, field, and other properties.

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

Retrieves basic metadata for a choice, including its name, field, and other properties.

Task<ChoiceResponse> ReadAsync(int workspaceID, Guid choiceGuid, bool includeMetadata, bool includeActions)

Retrieves basic metadata for a choice, including its name, field, and other properties.

Task<MassActionChoiceResponse> SortAsync(int workspaceID, int fieldID, ChoiceReorderTypeEnum sortType)

Sorts alphabetically by Name all choices associated with a field.

Task UpdateAsync(int workspaceID, int choiceID, ChoiceRequest choiceRequest)

Updates data of an existing choice

Task UpdateAsync(int workspaceID, int choiceID, ChoiceRequest choiceRequest, string objectVersionToken)

Updates the information of a list of choices throught a bulk operation.

Task UpdateAsync(int workspaceID, Guid choiceGuid, ChoiceRequest choiceRequest)

Updates the information of a list of choices throught a bulk operation.

Task UpdateAsync(int workspaceID, Guid choiceGuid, ChoiceRequest choiceRequest, string objectVersionToken)

Restricts updates to the properties of the choice to the date that it was last modified

Task<MassActionChoiceResponse> UpdateAsync(int workspaceID, MassUpdateChoiceRequest[] massUpdateChoices)

Performs a mass update for a list of choices.

Task<MassActionChoiceResponse> UpdateAsync(int workspaceID, MassUpdateChoiceRequest[] massUpdateChoices, CancellationToken cancel, IProgress<ProgressReport> progress)

Performs a mass update for a list of choices.