Represents a workspace.
Inheritance Hierarchy
kCura.Relativity.Client.DTOs.Artifact
kCura.Relativity.Client.DTOs.Workspace
Namespace: kCura.Relativity.Client.DTOs
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The Workspace type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | Workspace() |
Creates a new instance of the Workspace class.
|
![]() | Workspace(List<Guid>) |
Initializes a new instance of the Workspace class with the given list of Artifact GUIDs.
|
![]() | Workspace(Guid) |
Initializes a new instance of the Workspace class with the given Artifact GUID.
|
![]() | Workspace(Int32) |
Initializes a new instance of the Workspace class with the given ArtifactID.
|
Properties
Name | Description | |
---|---|---|
![]() | Accessible |
Indicates whether the workspace has been upgraded to the current version of Relativity.
|
![]() | 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.) |
![]() | Client |
Indicates the ArtifactID of the client associated with the workspace.
|
![]() | Credentials |
Represents a list of Credentials related to the Workspace.
NOTE: INTERNAL USE ONLY
|
![]() | DatabaseLocation |
Indicates the name of the server where the database is located.
|
![]() | DefaultCacheLocation |
Indicates the ArtifactID of the Default Cache Location server associated with the workspace.
|
![]() | DefaultDataGridLocation |
The path of the physical location for the files associated with Data Grid data for the case. It is specified as a ResourceServer object that represents the Data Grid resource server.
|
![]() | DefaultFileLocation |
The path of the physical location for the files associated with the case. It is specified as a Choice object that represents the file share resource server.
|
![]() | DownloadHandlerApplicationPath |
Indicates a string that identifies default URL for code used in downloading files for users.
|
![]() | EnableDataGrid |
Represents the whether Data Grid has been enabled for the workspace.
|
![]() | Fields |
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.) |
![]() | 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.) |
![]() | MatterID |
Indicates the ArtifactID of the matter associated with the workspace.
|
![]() | Name |
Represents a string used to identify a workspace,
and it is equivalent to the TextIdentifer property on Artifact.
|
![]() | ParentArtifact |
Indicates the parent of an Artifact.
(Inherited from Artifact.) |
![]() | ResourcePoolID |
Returns an integer ID representing the resource pool.
|
![]() | RootFolderID |
Indicates the ArtifactID assigned to the root folder of the workspace.
|
![]() | ServerID |
Indicates the ArtifactID of the server where the workspace database resides.
|
![]() | SQLFullTextLanguageCodeID |
Returns an integer representing the language used for word-break characters in the full text index.
|
![]() | Status |
Represents the status of the workspace.
|
![]() | 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.) |
![]() | WorkspaceAdminGroup |
Indicates the Group assigned Admin permissions to Workspace.
|
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