UserFieldNames Class

Relativity Services API
The string names of fields used on Users.
Inheritance Hierarchy

System.Object
  kCura.Relativity.Client.DTOs.ArtifactFieldNames
    kCura.Relativity.Client.DTOs.UserFieldNames

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

public class UserFieldNames : ArtifactFieldNames

The UserFieldNames type exposes the following members.

Constructors

  NameDescription
Public methodUserFieldNames
Initializes a new instance of the UserFieldNames class
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 object.
(Inherited from Object.)
Top
Fields

  NameDescription
Public fieldStatic memberAdvancedSearchPublicByDefault
Indicates whether saved searches created by the user are public by default.
Public fieldStatic memberAuthenticationData
Indicates the authentication method for the user, such as RSA, SSL, or Active Directory.
Public fieldStatic memberBetaUser
Indicates whether or not this is a beta user.
Public fieldStatic memberCanChangeDocumentViewer
Indicates whether a user can change the Document Viewer
Public fieldStatic memberChangePassword
Indicates whether a user can update the Relativity password.
Public fieldStatic memberChangePasswordNextLogin
Indicates whether a user must update the Relativity password on next login.
Public fieldStatic memberChangeSettings
Indicates whether the user can change settings, such as name, email address, item list page length, and others.
Public fieldStatic memberClient
Represents the client associated with this user.
Public fieldStatic memberDataFocus
Controls whether or not the workspace name is displayed at the top of the Relativity web UI.
Public fieldStatic memberDefaultSelectedFileType
Provides the Choice of the default file type that will be displayed in the viewer.
Public fieldStatic memberDisableDate
Indicates the date and time when a user's access will be disabled UTC.
Public fieldStatic memberDocumentSkip
Provides the Choice of the document skip value, which advances the user to the next document when the view conditions are met.
Public fieldStatic memberDocumentViewer
Provides the Choice of the document viewer that will be used to render documents in the viewer.
Public fieldStatic memberEmailAddress
Represents the email address of a user as a string.
Public fieldStatic memberEnforceViewerCompatibility
Indicates whether a user is required to download a new version of the viewer when available.
Public fieldStatic memberFirstName
Represents the first name of a user as a string.
Public fieldStatic memberFullName
Represents the first and last name of a user as a string. It is read-only.
Public fieldStatic memberGroups
Provides a list of groups that the user has been added to.
Public fieldStatic memberInvalidLoginAttempts
Indicates the number of attempts made by the user to log in with an invalid password.
Public fieldStatic memberItemListPageLength
Sets the number of items displayed for the user in all Relativity views.
Public fieldStatic memberKeyboardShortcuts
Determines whether keyboard shortcuts are available to the user in the viewer.
Public fieldStatic memberLastName
Represents the last name of a user as a string.
Public fieldStatic memberMaximumPasswordAge
Determines the number of days until the user's passsword expires.
Public fieldStatic memberNativeViewerCacheAhead
Determines whether the next native document is preloaded in the viewer.
Public fieldStatic memberPassword
Contains the new value for a password assigned during a create or update operation.
Public fieldStatic memberPasswordAction
Indicates how a password is assigned to the user.
Public fieldStatic memberPasswordLastResetOn
Indicates the date when the user's password was last reset.
Public fieldStatic memberRelativityAccess
Indicates whether a user will be alloed to log in to Relativity.
Public fieldStatic memberSendPasswordTo
Indicates how a user is notified about a new password.
Public fieldStatic memberShowFilters
Determines whether the Show Filters option is displayed in the Relativity web UI.
Public fieldStatic memberSkipDefaultPreference
Indicates whether to advance to the next document that matches the view conditions or to display all documents in the queue.
Public fieldStatic memberTrustedIPs
Determines the trusted IP addresses for a user.
Public fieldStatic memberType
Provides the Choice of the user type, such as internal or external.
Public fieldStatic memberWorkspaces
Provides a list of workspaces that this user can access.
Public fieldStatic memberWorkspaceUserIDs
Returns a list mapping the user's ArtifactIDs to their corresponding workspace ArtifactIDs.
Top
See Also

Reference