Class User

Represents the Relativity user object.

Inheritance

System.Object

Artifact

NamedArtifact

User

Implements

IHasName

IFillsRequiredProperties<User>

Inherited Members

NamedArtifact.Name

Artifact.ArtifactID

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Relativity.Testing.Framework.Models

Assembly: Relativity.Testing.Framework.dll

Syntax

public class User : NamedArtifact, IHasName, IFillsRequiredProperties<User>

Fields

| Improve this Doc View Source

DefaultItemListPageLength

The default item list page length.

Declaration

public const int DefaultItemListPageLength = 200

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

DefaultMaximumPasswordAge

The default maximum password age.

Declaration

public const int DefaultMaximumPasswordAge = 365

Field Value

Type	Description
System.Int32

Properties

| Improve this Doc View Source

AdvancedSearchPublicByDefault

Gets or sets a value indicating whether the advanced search is public by default. The default value is true.

Declaration

public bool AdvancedSearchPublicByDefault { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

BetaUser

Gets or sets a value indicating whether the user is beta one. The default value is false.

Declaration

public bool BetaUser { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

CanChangeDocumentViewer

Gets or sets a value indicating whether this user can change document viewer. The default value is false.

Declaration

public bool CanChangeDocumentViewer { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

ChangePassword

Gets or sets a value indicating whether the password can be changed. The default value is true.

Declaration

public bool ChangePassword { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

ChangePasswordNextLogin

Gets or sets a value indicating whether to change password on next login. The default value is false.

Declaration

public bool ChangePasswordNextLogin { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

ChangeSettings

Gets or sets a value indicating whether the change of settings is allowed. The default value is true.

Declaration

public bool ChangeSettings { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Client

Gets or sets the client.

Declaration

public Client Client { get; set; }

Property Value

Type	Description
Client

| Improve this Doc View Source

DataFocus

Gets or sets the data focus. The default value is 1.

Declaration

public int DataFocus { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

DefaultSelectedFileType

Gets or sets the default selected file type. The default value is Viewer.

Declaration

public UserDefaultSelectedFileType DefaultSelectedFileType { get; set; }

Property Value

Type	Description
UserDefaultSelectedFileType

| Improve this Doc View Source

DisableOnDate

Gets or sets the date on which the used should become disabled.

Declaration

public DateTime? DisableOnDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

| Improve this Doc View Source

DocumentSkip

Gets or sets the document skip. The default value is Enabled.

Declaration

public UserDocumentSkip DocumentSkip { get; set; }

Property Value

Type	Description
UserDocumentSkip

| Improve this Doc View Source

DocumentViewer

Gets or sets the document viewer. The default value is Default.

Declaration

public UserDocumentViewer DocumentViewer { get; set; }

Property Value

Type	Description
UserDocumentViewer

| Improve this Doc View Source

EmailAddress

Gets or sets the email address.

Declaration

public virtual string EmailAddress { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

EmailPreference

Gets or sets email preferences for user.

Declaration

public UserEmailPreference EmailPreference { get; set; }

Property Value

Type	Description
UserEmailPreference

| Improve this Doc View Source

EnforceViewerCompatibility

Gets or sets a value indicating whether to enforce viewer compatibility. The default value is true.

Declaration

public bool EnforceViewerCompatibility { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

FirstName

Gets or sets the first name.

Declaration

public string FirstName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

FullName

Gets or sets the full name.

Declaration

public string FullName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Groups

Gets or sets the collection of groups the user belongs to.

Declaration

public List<Artifact> Groups { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<Artifact>

| Improve this Doc View Source

ItemListPageLength

Gets or sets the item list page length. The default value is DefaultItemListPageLength.

Declaration

public int ItemListPageLength { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

KeyboardShortcuts

Gets or sets a value indicating whether to enable keyboard shortcuts. The default value is true.

Declaration

public bool KeyboardShortcuts { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

LastName

Gets or sets the last name.

Declaration

public string LastName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

MaximumPasswordAge

Gets or sets the maximum password age in days. The default value is DefaultMaximumPasswordAge.

Declaration

public int MaximumPasswordAge { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

NativeViewerCacheAhead

Gets or sets a value indicating whether the native viewer cache is ahead. The default value is true.

Declaration

public bool NativeViewerCacheAhead { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Password

Gets or sets the password.

Declaration

public string Password { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

RelativityAccess

Gets or sets a value indicating whether the user has Relativity access. The default value is true.

Declaration

public bool RelativityAccess { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

ShowFilters

Gets a value indicating whether to show filters. The default value is true.

Declaration

public bool ShowFilters { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

SkipDefaultPreference

Gets or sets the skip default preference. The default value is Normal.

Declaration

public UserSkipDefaultPreference SkipDefaultPreference { get; set; }

Property Value

Type	Description
UserSkipDefaultPreference

| Improve this Doc View Source

TrustedIPs

Gets or sets the trusted IPs.

Declaration

[FieldName("Trusted IPs")]
public string TrustedIPs { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Type

Gets or sets the type of the user. The default value is "Internal".

Declaration

public virtual string Type { get; set; }

Property Value

Type	Description
System.String

Methods

| Improve this Doc View Source

FillRequiredProperties()

Fills the required properties.

Declaration

public User FillRequiredProperties()

Returns

Type	Description
User	The same User object instance.

Implements

IHasName

IFillsRequiredProperties<T>