RelativityApplication Class

Relativity Services API
Represents a Relativity Application.
Inheritance Hierarchy

System.Object
  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

public class RelativityApplication : Artifact

The RelativityApplication type exposes the following members.

Constructors

  NameDescription
Public methodRelativityApplication()
Creates a new instance of the RelativityApplication class.
Public methodRelativityApplication(Int32)
Initializes a new instance of the RelativityApplication class with the given ArtifactID.
Top
Properties

  NameDescription
Public propertyAgentTypes
Provides a list of agent types associated with an application.
Public propertyApplicationFields
Provides a list of fields associated with an application.
Public propertyApplicationInstallationStatus
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.
Public propertyApplicationIsDirty
Indicates whether the application has been unlocked since the last upgrade.
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 propertyChoices
Provides a list of choices associated with an application.
Public propertyCustomPages
Provides a list of custom pages associated with an application.
Public propertyEventHandlers
Provides a list of event handlers used to add custom functionality to the application.
Public propertyFields
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.)
Public propertyGlobalApplication
Gets or sets the string for the Global Application Flag.
Public propertyGuids
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.)
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 propertyLastExported
Provides the date that an application was last exported.
Public propertyLayouts
Provides a list of layouts associated with the application.
Public propertyLocked
Indicates whether the application or any of its associated objects can be edited.
Public propertyName
Represents the name of a Relativity application as a string.
Public propertyObjectRules
Provides a list of rules that control specific aspects of an object type's behavior.
Public propertyObjectTypes
Provides a list of object types associated with the application.
Public propertyOriginSignature
Indicates whether the origin of an application that is being upgraded matches that of the new version being installed.
Public propertyParentArtifact
Indicates the parent of an Artifact.
(Inherited from Artifact.)
Public propertyRelativityScripts
Provides a list of scripts used by an application to manipulate Relativity data without directly accessing the SQL server.
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 propertyTabDisplay
Indicates whether the tabs in an application should display in a vertical or horizontal list under the parent tab.
Public propertyTabs
Provides a list of tabs associated with an application.
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 propertyUserFriendlyURL
Gets or sets the string for the user-friendly URL used to reference custom pages in a Relativity application.
Public propertyVersion
Provides the version number assigned to an application as a string.
Public propertyViews
Provides a list of views associated with an application.
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
See Also

Reference