User Class

Relativity Services API
Represents a user.
Inheritance Hierarchy

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

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

public class User : Artifact

The User type exposes the following members.

Constructors

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

  NameDescription
Public propertyAdvancedSearchPublicByDefault
Indicates whether saved searches created by the user are public by default.
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 propertyAuthenticationData
Indicates the authentication method for the user, such as RSA, SSL, or Active Directory.
Public propertyBetaUser
Indicates whether or not this is a beta user.
Public propertyCanChangeDocumentViewer
Indicates whether a user can change the document viewer
Public propertyChangePassword
Indicates whether a user can update the Relativity password.
Public propertyChangePasswordNextLogin
Indicates whether a user must update the Relativity password on next login.
Public propertyChangeSettings
Indicates whether the user can change settings, such as name, email address, item list page length, and others.
Public propertyClient
Represents the client associated with this user.
Public propertyDataFocus
Controls whether or not the workspace name is displayed at the top of the Relativity web UI.
Public propertyDefaultSelectedFileType
Provides the Choice of the default file type that will be displayed in the viewer.
Public propertyDisableDate
Indicates the date and time when a user's access will be disabled (UTC).
Public propertyDocumentSkip
Provides the Choice of the document skip value, which advances the user to the next document when the view conditions are met.
Public propertyDocumentViewer
Provides the Choice of the document viewer that will be used to render documents in the viewer.
Public propertyEmailAddress
Represents the email address of a user as a string.
Public propertyEnforceViewerCompatibility
Indicates whether a user is required to download a new version of the viewer when available.
Public propertyFields
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.)
Public propertyFirstName
Represents the first name of a user as a string.
Public propertyFullName
Represents the first and last name of a user as a string. It is read-only.
Public propertyGroups
Provides a list of groups that the user has been added to.
Public propertyGuids
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.)
Public propertyInvalidLoginAttempts
Indicates the number of attempts made by the user to log in with an invalid password.
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 propertyItemListPageLength
Sets the number of items displayed for the user in all Relativity views.
Public propertyKeyboardShortcuts
Determines whether keyboard shortcuts are available to the user in the viewer.
Public propertyLastName
Represents the last name of a user as a string.
Public propertyMaximumPasswordAge
Determines the number of days until the user's passsword expires.
Public propertyNativeViewerCacheAhead
Determines whether the next native document is preloaded in the viewer.
Public propertyParentArtifact
Indicates the parent of an Artifact.
(Inherited from Artifact.)
Public propertyPassword
Contains the new value for a password assigned during a create or update operation.
Public propertyPasswordAction
Indicates how a password is assigned to the user.
Public propertyPasswordLastResetOn
Indicates the date when the user's password was last reset.
Public propertyRelativityAccess
Indicates whether a user will be alloed to log in to Relativity.
Public propertySendPasswordTo
Indicates how a user is notified about a new password.
Public propertyShowFilters
Determines whether the Show Filters option is displayed in the Relativity web UI.
Public propertySkipDefaultPreference
Indicates whether to advance to the next document that matches the view conditions or to display all documents in the queue.
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 propertyTrustedIPs
Determines the trusted IP addresses for a user.
Public propertyType
Provides the Choice of the user type, such as internal or external.
Public propertyWorkspaces
Provides a list of workspaces that this user can access.
Public propertyWorkspaceUserIDs
Returns a list mapping the user's ArtifactIDs to their corresponding workspace ArtifactIDs.
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 User class supports create, read, update, delete, and query operations.
See Also

Reference