Choice Class

Relativity Services API
Represents a Choice used as a value for Single or Multiple Choice fields in Relativity.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.Choice

Namespace:  kCura.Relativity.Client
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public class Choice

The Choice type exposes the following members.

Constructors

  NameDescription
Public methodChoice()
Creates a new Choice object.
Public methodChoice(List<Guid>, String)
Creates a new Choice object.
Public methodChoice(Guid, String)
Creates a new Choice object.
Public methodChoice(Int32, String)
Creates a new Choice object.
Public methodChoice(Int32, List<Guid>, String)
Creates a new Choice object.
Public methodChoice(Int32, Guid, String)
Creates a new Choice object.
Top
Properties

  NameDescription
Public propertyArtifactGuids
Provides a list of GUIDs representing a Choice. Use as an alternative to ArtifactID.
Public propertyArtifactID
Indicates the unique identifier for a Choice. Use as an alternative to ArtifactGuids.
Public propertyName
Indicates the display name of a Choice.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Converts the object to it's string representation, "Choice([ArtifactID], [Name])".
(Overrides Object.ToString().)
Top
Remarks

A Choice object is returned when reading or querying Single or MultiChoice fields. To set or update a Single Choice field, use the ArtifactID or ArtifactGuids properties on a Choice object. For MultiChoice fields, use a MultiChoiceUpdateValue object when creating or updating them. Pass a List of ArtifactID objects or GUIDs when setting the values for Choice objects on Create.
See Also

Reference