Represents a user.
Inheritance Hierarchy
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
The User type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | User() |
Creates a new instance of the User class.
|
![]() | User(Int32) |
Initializes a new instance of the User class with the given ArtifactID.
|
Properties
Name | Description | |
---|---|---|
![]() | AdvancedSearchPublicByDefault |
Indicates whether saved searches created by the user are public by default.
|
![]() | 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.) |
![]() | AuthenticationData |
Indicates the authentication method for the user, such as RSA, SSL, or Active Directory.
|
![]() | BetaUser |
Indicates whether or not this is a beta user.
|
![]() | CanChangeDocumentViewer |
Indicates whether a user can change the document viewer
|
![]() | ChangePassword |
Indicates whether a user can update the Relativity password.
|
![]() | ChangePasswordNextLogin |
Indicates whether a user must update the Relativity password on next login.
|
![]() | ChangeSettings |
Indicates whether the user can change settings, such as name, email address,
item list page length, and others.
|
![]() | Client |
Represents the client associated with this user.
|
![]() | DataFocus |
Controls whether or not the workspace name is displayed at the top of
the Relativity web UI.
|
![]() | DefaultSelectedFileType |
Provides the Choice of the default file type that will be displayed
in the viewer.
|
![]() | DisableDate |
Indicates the date and time when a user's access will be disabled (UTC).
|
![]() | DocumentSkip |
Provides the Choice of the document skip value, which advances the
user to the next document when the view conditions are met.
|
![]() | DocumentViewer |
Provides the Choice of the document viewer that will be used to render documents
in the viewer.
|
![]() | EmailAddress |
Represents the email address of a user as a string.
|
![]() | EnforceViewerCompatibility |
Indicates whether a user is required to download a new version of the
viewer when available.
|
![]() | Fields |
Provides a collection of FieldValue objects representing the field values on an Artifact instance.
(Inherited from Artifact.) |
![]() | FirstName |
Represents the first name of a user as a string.
|
![]() | FullName |
Represents the first and last name of a user as a string. It is read-only.
|
![]() | Groups |
Provides a list of groups that the user has been added to.
|
![]() | Guids |
Provides a list of GUIDs used to identify an Artifact.
(Inherited from Artifact.) |
![]() | InvalidLoginAttempts |
Indicates the number of attempts made by the user to log in with an invalid password.
|
![]() | 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.) |
![]() | ItemListPageLength |
Sets the number of items displayed for the user in all Relativity views.
|
![]() | KeyboardShortcuts |
Determines whether keyboard shortcuts are available to the user in the viewer.
|
![]() | LastName |
Represents the last name of a user as a string.
|
![]() | MaximumPasswordAge |
Determines the number of days until the user's passsword expires.
|
![]() | NativeViewerCacheAhead |
Determines whether the next native document is preloaded in the viewer.
|
![]() | ParentArtifact |
Indicates the parent of an Artifact.
(Inherited from Artifact.) |
![]() | Password |
Contains the new value for a password assigned during a create or update operation.
|
![]() | PasswordAction |
Indicates how a password is assigned to the user.
|
![]() | PasswordLastResetOn |
Indicates the date when the user's password was last reset.
|
![]() | RelativityAccess |
Indicates whether a user will be alloed to log in to Relativity.
|
![]() | SendPasswordTo |
Indicates how a user is notified about a new password.
|
![]() | ShowFilters |
Determines whether the Show Filters option is displayed in the Relativity web UI.
|
![]() | SkipDefaultPreference |
Indicates whether to advance to the next document that matches the view
conditions or to display all documents in the queue.
|
![]() | 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.) |
![]() | TrustedIPs |
Determines the trusted IP addresses for a user.
|
![]() | Type |
Provides the Choice of the user type, such as internal or external.
|
![]() | Workspaces |
Provides a list of workspaces that this user can access.
|
![]() | WorkspaceUserIDs |
Returns a list mapping the user's ArtifactIDs to their corresponding workspace ArtifactIDs.
|
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