Credential Class

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

System.Object
  kCura.Relativity.Client.Credential

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

public class Credential

The Credential type exposes the following members.

Constructors

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

  NameDescription
Public propertyArtifactGuids
Provides a list of GUIDs representing a Credential. Use as an alternative to ArtifactID.
Public propertyArtifactID
Indicates the unique identifier for a Credential. Use as an alternative to ArtifactGuids.
Public propertyName
Indicates the display name of a Credential.
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, "Credential([ArtifactID], [Name])".
(Overrides Object.ToString().)
Top
Remarks

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

Reference