Represents an error that occurred in Relativity.
Inheritance Hierarchy
kCura.Relativity.Client.DTOs.Artifact
kCura.Relativity.Client.DTOs.Error
Namespace: kCura.Relativity.Client.DTOs
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The Error type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | Error() |
Initializes a new instance of the Error class.
|
![]() | Error(Int32) |
Initializes a new instance of the Error class with the given ArtifactID.
|
Properties
Name | Description | |
---|---|---|
![]() | ArtifactID |
Represents a unique identifier for an Artifact.
(Inherited from Artifact.) |
![]() | ArtifactTypeGuids |
Provides a list of GUIDs defined for the ArtifactType.
(Inherited from Artifact.) |
![]() | ArtifactTypeID |
Represents the identifier for the type of item that the Artifact represents.
(Inherited from Artifact.) |
![]() | ArtifactTypeName |
Indicates name of the ArtifactType used to define the Artifact.
(Inherited from Artifact.) |
![]() | Fields |
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.) |
![]() | FullError |
Provides a detailed error message, such as a stack trace.
|
![]() | Guids |
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.) |
![]() | Item[Guid] |
Provides a shortcut to the field collection of an Artifact by using the GUID assigned to Fields.
(Inherited from Artifact.) |
![]() | Item[Int32] |
Provides a shortcut to a field collection of an Artifact by using the ArtifactID assigned to Fields.
(Inherited from Artifact.) |
![]() | Item[String] |
Provides a shortcut to a field collection of an Artifact by using the ArtifactTypeName.
(Inherited from Artifact.) |
![]() | Message |
Provides a brief message summarizing the error.
|
![]() | ParentArtifact |
Indicates the parent of an Artifact.
(Inherited from Artifact.) |
![]() | SendNotification |
Indicates whether to send a notification message when an error occurs.
|
![]() | Server |
Indicates the server where the error occurred.
|
![]() | Source |
Indicates the component of the Relativity application where the error
occurred, such as the web, or agent.
|
![]() | SystemCreatedBy |
Identifies the User who created the Artifact. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | SystemCreatedOn |
Represents the DateTime in UTC when the Artifact was created. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | SystemLastModifiedBy |
Identifies the User who last modified the Artifact. This property is available in the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | SystemLastModifiedOn |
Represents the DateTime in UTC when the Artifact was last modified. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.) |
![]() | TextIdentifier |
Indicates the value of the IdentifierFieldName field available in Fields property of the Artifact.
This field may also be available as a Name property for many Artifacts.
(Inherited from Artifact.) |
![]() | URL |
Indicates the URL at which the error occurred.
|
![]() | Workspace |
Indicates the workspace where the error occurred.
|
Methods
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | ToString |
Returns a string that represents the current Artifact.
(Inherited from Artifact.) |
Remarks
See Also