Represents a Relativity Application.
Inheritance Hierarchy
kCura.Relativity.Client.DTOs.Artifact
kCura.Relativity.Client.DTOs.RelativityApplication
Namespace: kCura.Relativity.Client.DTOs
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The RelativityApplication type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | RelativityApplication() |
Creates a new instance of the RelativityApplication class.
|
![]() | RelativityApplication(Int32) |
Initializes a new instance of the RelativityApplication class with the given ArtifactID.
|
Properties
Name | Description | |
---|---|---|
![]() | AgentTypes |
Provides a list of agent types associated with an application.
|
![]() | ApplicationFields |
Provides a list of fields associated with an application.
|
![]() | ApplicationInstallationStatus |
The outcome of most recent application installation. An empty string value indicates success, otherwise it's a message describing the error that occurred. Note that field can't be used to check the application installation status in real time.
|
![]() | ApplicationIsDirty |
Indicates whether the application has been unlocked since the last upgrade.
|
![]() | 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.) |
![]() | Choices |
Provides a list of choices associated with an application.
|
![]() | CustomPages |
Provides a list of custom pages associated with an application.
|
![]() | EventHandlers |
Provides a list of event handlers used to add custom functionality to the application.
|
![]() | Fields |
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.) |
![]() | GlobalApplication |
Gets or sets the string for the Global Application Flag.
|
![]() | 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.) |
![]() | LastExported |
Provides the date that an application was last exported.
|
![]() | Layouts |
Provides a list of layouts associated with the application.
|
![]() | Locked |
Indicates whether the application or any of its associated objects can be edited.
|
![]() | Name |
Represents the name of a Relativity application as a string.
|
![]() | ObjectRules |
Provides a list of rules that control specific aspects of an object type's behavior.
|
![]() | ObjectTypes |
Provides a list of object types associated with the application.
|
![]() | OriginSignature |
Indicates whether the origin of an application that is being upgraded matches
that of the new version being installed.
|
![]() | ParentArtifact |
Indicates the parent of an Artifact.
(Inherited from Artifact.) |
![]() | RelativityScripts |
Provides a list of scripts used by an application to manipulate Relativity data
without directly accessing the SQL server.
|
![]() | 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.) |
![]() | TabDisplay |
Indicates whether the tabs in an application should display in a vertical or
horizontal list under the parent tab.
|
![]() | Tabs |
Provides a list of tabs associated with an application.
|
![]() | 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.) |
![]() | UserFriendlyURL |
Gets or sets the string for the user-friendly URL used to reference custom pages in a Relativity application.
|
![]() | Version |
Provides the version number assigned to an application as a string.
|
![]() | Views |
Provides a list of views associated with an application.
|
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.) |
See Also