Artifact Class

Relativity Services API
Represents an item in a Relativity workspace.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.Artifact

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

public class Artifact

The Artifact type exposes the following members.

Constructors

  NameDescription
Public methodArtifact()
Default constructor for the Aritfact Class
Public methodArtifact(Int32)
Instantiates a new Artifact object for a particular Case
Public methodArtifact(Int32, List<Guid>)
Initializes a new instance of the Artifact class.
Public methodArtifact(Int32, Int32)
Instantites a new Artifact object for a particular Case and of a Particular Type
Public methodArtifact(Int32, String)
Initializes a new instance of the Artifact class.
Public methodArtifact(Int32, List<Guid>, List<Guid>)
Instantiates a new Artifact object for a particular Case, of a particular Artifact Type, and with a particular ArtifactID
Public methodArtifact(Int32, List<Guid>, Int32)
Instantiates a new Artifact object for a particular Case, of a particular Artifact Type, and with a particular ArtifactID
Public methodArtifact(Int32, Int32, List<Guid>)
Instantiates a new Artifact object for a particular Case, of a particular Artifact Type, and with a particular ArtifactID
Public methodArtifact(Int32, Int32, Int32)
Instantiates a new Artifact object for a particular Case, of a particular Artifact Type, and with a particular ArtifactID
Public methodArtifact(Int32, String, List<Guid>)
Initializes a new instance of the Artifact class.
Public methodArtifact(Int32, String, Int32)
Initializes a new instance of the Artifact class.
Public methodArtifact(Int32, List<Guid>, List<Guid>,Field[])
Instantiates a new Relativity object for a particular Workspace, of a Particular ArtifactType, with a specific ArtifactID and with a set of specifc fields.
Public methodArtifact(Int32, List<Guid>, Int32,Field[])
Instantiates a new Relativity object for a particular Workspace, of a Particular ArtifactType, with a specific ArtifactID and with a set of specifc fields.
Public methodArtifact(Int32, Int32, List<Guid>,Field[])
Instantiates a new Relativity object for a particular Workspace, of a Particular ArtifactType, with a specific ArtifactID and with a set of specifc fields.
Public methodArtifact(Int32, Int32, Int32,Field[])
Instantiates a new Relativity object for a particular Workspace, of a Particular ArtifactType, with a specific ArtifactID and with a set of specifc fields.
Public methodArtifact(Int32, String, List<Guid>,Field[])
Instantiates a new Relativity object for a particular Workspace, of a Particular ArtifactType, with a specific ArtifactID and with a set of specifc fields.
Public methodArtifact(Int32, String, Int32,Field[])
Initializes a new instance of the Artifact class.
Top
Properties

  NameDescription
Public propertyArtifactGuids
Provides a list of GUIDs for the Artifact. Use as an alternative to ArtifactID.
Public propertyArtifactID
Indicates a unique identifier for an Artifact.
Public propertyArtifactTypeGuids
Gets or sets a list of GUIDs for the Artifact Type.
Public propertyArtifactTypeID
Indicates the identifier for the type of item that the Artifact represents.
Public propertyArtifactTypeName
Indicates the name of the Artifact type. Use as an alternative to ArtifactTypeID.
Public propertyFields
Provides a collection of Field objects. A Field describes a single property of an Artifact.
Public propertyName
Indicates the display name of the Artifact.
Public propertyParentArtifactID
Indicates the identifier for the parent or container of an Artifact.
Public propertyWorkspaceID
Indicates the unique identifier for a workspace.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodgetFieldByName
Returns the field whose Name matches the name passed in. Note that this is just a helper function, and that its runtime is linear with the number of fields.
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, beginning with "Artifact( Name="[Name]", ArtifactID=[ArtifactID], ParentArtifactID=[ParentArtifactID], ArtifactTypeID=[ArtifactTypeID], ArtifactTypeName="[ArtifactTypeName]", WorkspaceID=[WorkspaceID]", and continuing with a line for each field name and value pair.
(Overrides Object.ToString().)
Top
Remarks

An Artifact can hold information about Documents and custom objects, as well as metadata about the workspace structure, including fields, choices, and folders that it contains.
See Also

Reference