Document Class

Relativity Services API
Represents a document.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.DTOs.Artifact
    kCura.Relativity.Client.DTOs.Document

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

public class Document : Artifact

The Document type exposes the following members.

Constructors

  NameDescription
Public methodDocument()
Initializes a new instance of the Document class.
Public methodDocument(Int32)
Initializes a new instance of the Document class with the given ArtifactID.
Top
Properties

  NameDescription
Public propertyArtifactID
Represents a unique identifier for an Artifact.
(Inherited from Artifact.)
Public propertyArtifactTypeGuids
Provides a list of GUIDs defined for the ArtifactType.
(Inherited from Artifact.)
Public propertyArtifactTypeID
Represents the identifier for the type of item that the Artifact represents.
(Inherited from Artifact.)
Public propertyArtifactTypeName
Indicates name of the ArtifactType used to define the Artifact.
(Inherited from Artifact.)
Public propertyBatch
Indicates the batch that the document is assigned to.
Public propertyBatch_AssignedTo
Indicates the user assigned to the batch that contains this document.
Public propertyBatch_BatchSet
Indicates the batch set that the document is assigned to.
Public propertyBatch_Status
Indicates the status of the batch.
Public propertyFields
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.)
Public propertyFileIcon
Represents the file icon associated with the document.
Public propertyFolderName
Indicates the name of the folder in Relativity, where the document is located.
Public propertyGuids
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.)
Public propertyHasImages
Indicates whether images of the document exist.
Public propertyHasInlineTags
Indicates whether inline tags have been applied to the document.
Public propertyHasNative
Indicates whether a native file exists for the document.
Public propertyImageQCStatus
Indicates whether the document's images, if any exist, are hidden for QC review.
Public propertyItem[Guid]
Provides a shortcut to the field collection of an Artifact by using the GUID assigned to Fields.
(Inherited from Artifact.)
Public propertyItem[Int32]
Provides a shortcut to a field collection of an Artifact by using the ArtifactID assigned to Fields.
(Inherited from Artifact.)
Public propertyItem[String]
Provides a shortcut to a field collection of an Artifact by using the ArtifactTypeName.
(Inherited from Artifact.)
Public propertyParentArtifact
Indicates the parent of an Artifact.
(Inherited from Artifact.)
Public propertyRelativityImageCount
Provides the number of images associated with a document.
Public propertyRelativityNativeFileLocation
Specifies the local path for the native file.
Public propertyRelativityNativeTimeZoneOffset
Indicates the native time zone offset of the document.
Public propertyRelativityNativeType
Indicates the type of native file for a document.
Public propertySupportedByViewer
Indicates whether the Relativity viewer supports the native file type of a document.
Public propertySystemCreatedBy
Identifies the User who created the Artifact. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemCreatedOn
Represents the DateTime in UTC when the Artifact was created. This property is available on the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemLastModifiedBy
Identifies the User who last modified the Artifact. This property is available in the Fields property of the Artifact.
(Inherited from Artifact.)
Public propertySystemLastModifiedOn
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.)
Public propertyTextIdentifier
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.)
Public propertyTimeZoneField
Lists the ArtifactID representing the time zone of the document.
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
Returns a string that represents the current Artifact.
(Inherited from Artifact.)
Top
Remarks

The Document DTO supports create, read, update, delete, and query operations.
See Also

Reference