Table of Contents

Class User

Namespace
Geotab.Checkmate.ObjectModel
Assembly
Geotab.Checkmate.ObjectModel.dll

A user of the system. A user can be a MyGeotab user or a user that is a Driver.

[ReportClass]
public class User : NameEntityWithVersion, IEntity, IComparable, IIdentifiable, IVersion, IGroupLinked, IDefaultable, IMediaFiles, IInstanceSizeEstimate
Inheritance
User
Implements
Derived
Inherited Members
Extension Methods

Constructors

User()

Initializes a new instance of the User class.

public User()

User(Id?)

Initializes a new instance of the User class.

public User(Id? id)

Parameters

id Id

The Id.

User(Id?, long?, string?, string?, string?, string?, string?, UserAuthenticationType?, string?, string?, string?, DateTime?, DateTime?, IList<Group>?, IList<Group>?, IList<Group>?, IList<Group>?, ClientSettings?, Certificate?, DateTime?, IList<MediaFile>?, GroupFilter?, IAMMetadata?)

Initializes a new instance of the User class.

public User(Id? id, long? version, string? userId, string? email, string? firstName, string? lastName, string? password, UserAuthenticationType? loginType, string? comment, string? designation, string? employeeNo, DateTime? activeFrom, DateTime? activeTo, IList<Group>? companyGroups, IList<Group>? reportGroups, IList<Group>? securityGroups, IList<Group>? privateUserGroups, ClientSettings? clientSettings, Certificate? issuerCertificate, DateTime? lastAccessDate = null, IList<MediaFile>? mediaFiles = null, GroupFilter? accessGroupFilter = null, IAMMetadata? iamMetadata = null)

Parameters

id Id

The Id.

version long?

The version.

userId string

The user ID.

email string

The user email.

firstName string

The first name of the user.

lastName string

The last name of the user.

password string

The password.

loginType UserAuthenticationType?

The UserAuthenticationType.

comment string

The comment.

designation string

The designation.

employeeNo string

The employeeNo.

activeFrom DateTime?

The DateTime from when the User is valid.

activeTo DateTime?

The DateTime to when the User is valid.

companyGroups IList<Group>

Group collection this user belongs to.

reportGroups IList<Group>

Group collection this user belongs to with only report access.

securityGroups IList<Group>

Group collection that defines what parts of the system the user has access to. The Group(s) are located under the SecurityGroup system Group.

privateUserGroups IList<Group>

The private user group collection which is specifically used for generate dashboard and email report for the user itself.

clientSettings ClientSettings

The ClientSettings for this User.

issuerCertificate Certificate

The issuer Certificate. Only needed for users not using basic authentication.

lastAccessDate DateTime?

The DateTime that user last accessed.

mediaFiles IList<MediaFile>

The list of MediaFile of MediaType Image for the display pictures of this user

accessGroupFilter GroupFilter

Access Group Filter for the userqa

iamMetadata IAMMetadata

The IAMMetadata for the User.

User(Id, string, string, string, string, string, UserAuthenticationType?, string, string, string, DateTime?, DateTime?, IList<Group>, IList<Group>, IList<Group>, IList<Group>, ClientSettings, Certificate, DateTime?, IList<MediaFile>?, IAMMetadata?)

Initializes a new instance of the User class.

[Obsolete("Use constructor with version", false)]
public User(Id id, string userId, string email, string firstName, string lastName, string password, UserAuthenticationType? loginType, string comment, string designation, string employeeNo, DateTime? activeFrom, DateTime? activeTo, IList<Group> companyGroups, IList<Group> reportGroups, IList<Group> securityGroups, IList<Group> privateUserGroups, ClientSettings clientSettings, Certificate issuerCertificate, DateTime? lastAccessDate = null, IList<MediaFile>? mediaFiles = null, IAMMetadata? iamMetadata = null)

Parameters

id Id

The Id.

userId string

The user ID.

email string

The user email.

firstName string

The first name of the user.

lastName string

The last name of the user.

password string

The password.

loginType UserAuthenticationType?

The UserAuthenticationType.

comment string

The comment.

designation string

The designation.

employeeNo string

The employeeNo.

activeFrom DateTime?

The DateTime from when the User is valid.

activeTo DateTime?

The DateTime to when the User is valid.

companyGroups IList<Group>

Group collection this user belongs to.

reportGroups IList<Group>

Group collection this user belongs to with only report access.

securityGroups IList<Group>

Group collection that defines what parts of the system the user has access to. The Group(s) are located under the SecurityGroup system Group.

privateUserGroups IList<Group>

The private user group collection which is specifically used for generate dashboard and email report for the user itself.

clientSettings ClientSettings

The ClientSettings for this User.

issuerCertificate Certificate

The issuer Certificate. Only needed for users not using basic authentication.

lastAccessDate DateTime?

The DateTime that user last accessed.

mediaFiles IList<MediaFile>

The list of MediaFile of MediaType Image for the display pictures of this user

iamMetadata IAMMetadata

The IAMMetadata for the User.

User(User)

Initializes a new instance of the User class.

protected User(User user)

Parameters

user User

The user.

Properties

AcceptedEULA

Gets or sets a value indicating the user accepted MyGeotab EULA revision number. Default [null].

public int? AcceptedEULA { get; set; }

Property Value

int?

AcceptedEULA

AccessGroupFilter

Gets or sets the GroupFilter that the user belongs to, which is used to determine what the user can see within the database.

public GroupFilter? AccessGroupFilter { get; set; }

Property Value

GroupFilter

AccessGroupFilter

ActiveDashboardReports

Gets or sets the list of active dashboards for the user, displayed on the dashboard page. Default [empty].

public string[]? ActiveDashboardReports { get; set; }

Property Value

string[]

ActiveDashboardReports

ActiveDefaultDashboards

Gets or sets the list of default dashboards which must show real data. Default [empty].

public string[]? ActiveDefaultDashboards { get; set; }

Property Value

string[]

ActiveDefaultDashboards

ActiveFrom

Gets or sets the date the user is active from. Default [UtcNow].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserActiveFrom })]
public DateTime? ActiveFrom { get; set; }

Property Value

DateTime?

ActiveFrom

ActiveTo

Gets or sets the date the user is active to. Default [MaxDate].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserActiveTo })]
public DateTime? ActiveTo { get; set; }

Property Value

DateTime?

ActiveTo

AuthorityAddress

Gets or sets the HOS authority address of the user. Default [""].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserAuthorityAddress })]
public string? AuthorityAddress { get; set; }

Property Value

string

AuthorityAddress

AuthorityName

Gets or sets the HOS authority name of the user. Default [""].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserAuthorityName })]
public string? AuthorityName { get; set; }

Property Value

string

AuthorityName

AvailableDashboardReports

Gets or sets list of all available dashboard reports to the user. Default [empty].

public string[]? AvailableDashboardReports { get; set; }

Property Value

string[]

ICollection<T>AvailableDashboardReports

Bookmarks

Gets or sets the list of bookmarked pages. Default [empty].

public string[]? Bookmarks { get; set; }

Property Value

string[]

Bookmarks

CannedResponseOptions

Gets or sets the user's stored list of custom response options to choose from when sending a TextMessage. Each item is a set of predefined response options. Default [empty].

public string[][]? CannedResponseOptions { get; set; }

Property Value

string[][]

ICollection<T> List of custom responses for text messages.

CarrierNumber

Gets or sets the carrier number. Default [""].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserCarrierNumber })]
public string? CarrierNumber { get; set; }

Property Value

string

CarrierNumber

ChangePassword

Gets or sets a flag indicating whether the user's password requires resetting. If [true], the user will be forced to change their password on next login. Default [false].

public bool? ChangePassword { get; set; }

Property Value

bool?

ChangePassword

Comment

Gets or sets free text field where any user information can be stored and referenced for this entity. Default [""].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserComment })]
public string? Comment { get; set; }

Property Value

string

Comment

CompanyAddress

Gets or sets the company address for the user. Default [""].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserCompanyAddress })]
public string? CompanyAddress { get; set; }

Property Value

string

CompanyAddress

CompanyGroups

Gets or sets the list of organization Group(s) that the user belongs to.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.DisplayUserGroups }, IsList = true)]
public virtual IList<Group>? CompanyGroups { get; set; }

Property Value

IList<Group>

CompanyGroups

CompanyName

Gets or sets the name of the company for the user. Default [""].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserCompanyName })]
public string? CompanyName { get; set; }

Property Value

string

CompanyName

CountryCode

Gets or sets the user two symbols country ISO code (https://www.iso.org/iso-3166-country-codes.html). Maximum length [2] Default [""]

public string? CountryCode { get; set; }

Property Value

string

CountryCode

DateFormat

Gets or sets the format dates will be displayed to this user. Default ["MM/dd/yy HH:mm:ss"].

public string? DateFormat { get; set; }

Property Value

string

DateFormat

DefaultGoogleMapStyle

Gets or sets the default GoogleMapStyle tiles when using Google maps. Default [Roadmap].

public GoogleMapStyle? DefaultGoogleMapStyle { get; set; }

Property Value

GoogleMapStyle?

GoogleMapStyle

DefaultHereMapStyle

Gets or sets the default HereMapStyle tiles when using Here Maps. Default [Roadmap].

public HereMapStyle? DefaultHereMapStyle { get; set; }

Property Value

HereMapStyle?

DefaultHereMapStyle

DefaultMapEngine

Gets or sets the default map engine to use for this user. System map engines are:

Default ["MapBox"].

public string? DefaultMapEngine { get; set; }

Property Value

string

DefaultMapEngine

DefaultOpenStreetMapStyle

Gets or sets the default OpenStreetMapStyle tiles when using Open Street Maps. Default [MapBox].

public OpenStreetMapStyle? DefaultOpenStreetMapStyle { get; set; }

Property Value

OpenStreetMapStyle?

DefaultOpenStreetMapStyle

DefaultPage

Gets or sets the default start page to view when login is complete. Maps to the hash portion of the web site URL (https://url/enpoint/[#page]). Default [helpGuide].

public string? DefaultPage { get; set; }

Property Value

string

DefaultPage

Designation

Gets or sets the designation or title of the employee. Maximum length [50] Default [""].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserDesignation })]
public string? Designation { get; set; }

Property Value

string

Designation

DisplayCurrency

Gets or sets the user's preferred currency for display in the UI.

public Currency? DisplayCurrency { get; set; }

Property Value

Currency?

Currency

DisplayMeasurementProfile

Gets or sets the DisplayMeasurementProfile.

[Obsolete("DisplayMeasurementProfile is handled outside of the User class and not a property of it.")]
public DisplayMeasurementProfile? DisplayMeasurementProfile { get; set; }

Property Value

DisplayMeasurementProfile

DisplayMeasurementProfile

DriveGuideVersion

Gets or sets the driver's last viewed guide version. Default [0].

public int? DriveGuideVersion { get; set; }

Property Value

int?

DriveGuideVersion

ElectricEnergyEconomyUnit

Gets or sets the user's preferred ElectricEnergyEconomyUnit for viewing fuel economy. Default [LitersEPer100Km].

public ElectricEnergyEconomyUnit? ElectricEnergyEconomyUnit { get; set; }

Property Value

ElectricEnergyEconomyUnit?

ElectricEnergyEconomyUnit

EmployeeNo

Gets or sets the employee number or external identifier. Maximum length [50] Default [""].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserEmployeeNo })]
public string? EmployeeNo { get; set; }

Property Value

string

EmployeeNo

FeaturePreview

Gets or sets a comma-separated string value indicating which features user enabled to preview. Default [""].

public string? FeaturePreview { get; set; }

Property Value

string

FeaturePreview

FirstDayOfWeek

Gets or sets the user's preferred day to represent the start of the week. Default ["Sunday"].

public DayOfWeek? FirstDayOfWeek { get; set; }

Property Value

DayOfWeek?

FirstDayOfWeek

FirstName

Gets or sets the first name of the user. Maximum length [255].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserFirstName })]
public string? FirstName { get; set; }

Property Value

string

FirstName First name.

FuelEconomyUnit

Gets or sets the user's preferred FuelEconomyUnit for viewing fuel economy. Default [LitersPer100Km].

public FuelEconomyUnit? FuelEconomyUnit { get; set; }

Property Value

FuelEconomyUnit?

FuelEconomyUnit

Groups

Gets or sets the aggregated list of all user groups.

public IList<Group>? Groups { get; set; }

Property Value

IList<Group>

The aggregated list of all user groups.

HosRuleSet

Gets or sets the HosRuleSet the user follows. Default [None].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserHosRuleSet })]
public HosRuleSet? HosRuleSet { get; set; }

Property Value

HosRuleSet?

HosRuleSet

IAMMetadata

Gets or sets the user's metadata in IAM.

public IAMMetadata? IAMMetadata { get; set; }

Property Value

IAMMetadata

IAMMetadata

Id

Gets or sets the unique identifier for the User. See Id.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserId })]
public override Id? Id { get; set; }

Property Value

Id

Id

IsAdverseDrivingEnabled

Gets or sets a value indicating whether the user is allowed to Adverse Driving conditions exempt. Default [true].

public bool? IsAdverseDrivingEnabled { get; set; }

Property Value

bool?

IsAdverseDrivingEnabled

IsAutoAdded

Gets or sets a value indicating whether the user was automatically added to the database

public bool? IsAutoAdded { get; set; }

Property Value

bool?

IsAutoAdded

IsDriver

Gets or sets the isDriver toggle, if [true] the user is a driver, otherwise [false]. Default [false].

public bool? IsDriver { get; set; }

Property Value

bool?

IsDriver

IsEULAAccepted

Gets a value indicating whether the old EULA has been accepted by the end user. Default [false].

public bool? IsEULAAccepted { get; }

Property Value

bool?

IsEULAAccepted

IsEmailReportEnabled

Gets or sets the isEmailReportEnabled toggle, if [true] the user will receive the emailed report, otherwise [false]. Default [true].

public bool? IsEmailReportEnabled { get; set; }

Property Value

bool?

IsEmailReportEnabled

IsExemptHOSEnabled

Gets or sets a value indicating whether the user is allowed to HOS personal conveyance. Default [false].

public bool? IsExemptHOSEnabled { get; set; }

Property Value

bool?

IsExemptHOSEnabled

IsLabsEnabled

Gets a value indicating whether labs are enabled for this user. When set to true this will enable experimental features that are still in the process of being developed. Default [false].

public bool? IsLabsEnabled { get; }

Property Value

bool?

IsLabsEnabled

IsMetric

Gets or sets whether the current regional settings is in metric units of measurement (or US/Imperial). Default [true].

public bool? IsMetric { get; set; }

Property Value

bool?

IsMetric

IsNewsEnabled

Gets or sets a value that indicates whether news notifications are enabled for this user. Default [true].

public bool? IsNewsEnabled { get; set; }

Property Value

bool?

IsNewsEnabled

IsPersonalConveyanceEnabled

Gets or sets a value indicating whether the user is allowed to HOS personal conveyance. Default [false].

public bool? IsPersonalConveyanceEnabled { get; set; }

Property Value

bool?

IsPersonalConveyanceEnabled

IsYardMoveEnabled

Gets or sets a value indicating whether the user is allowed to HOS yard move. Default [false].

public bool? IsYardMoveEnabled { get; set; }

Property Value

bool?

IsYardMoveEnabled

IssuerCertificate

Gets or sets the issuer Certificate for the user. Will only be populated for users not using basic authentication.

public Certificate? IssuerCertificate { get; set; }

Property Value

Certificate

IssuerCertificate

JobPriorities

Gets or sets the list of selected job priorities. Default [empty].

public string[]? JobPriorities { get; set; }

Property Value

string[]

JobPriorities

Language

Gets or sets the user's culture identifier as a predefined CultureInfo name, Name of an existing System.Globalization.CultureInfo, or Windows-only culture name. Default: ["en"] for English.

public string? Language { get; set; }

Property Value

string

Language

LastAccessDate

Gets or sets the user's last access date of the system.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserLastAccessDate })]
public DateTime? LastAccessDate { get; set; }

Property Value

DateTime?

DateTime

Remarks

This value updates once per day, and will not be updated on consecutive logins in the same day.

LastName

Gets or sets the last name of the user. Maximum length [255].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserLastName })]
public string? LastName { get; set; }

Property Value

string

LastName

MapViews

Gets or sets the list of the of the available MapViews from the live map. Default [continent of the user's selected Timezone].

public List<MapView>? MapViews { get; set; }

Property Value

List<MapView>

MapViews

MaxPCDistancePerDay

Gets or sets a value indicating the maximum personal conveyance distance per day in meters. Default [0].

public double? MaxPCDistancePerDay { get; set; }

Property Value

double?

MaxPCDistance

MediaFiles

Gets or sets the list of MediaFile(s) photos of this user. Currently, a user can only be associated with at most one photo.

public virtual IList<MediaFile>? MediaFiles { get; set; }

Property Value

IList<MediaFile>

IList<T>

Name

Gets or sets the user's email address / login name. Maximum length [255].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserName })]
public override string? Name { get; set; }

Property Value

string

Name

NullifyAccessGroupFilter

Gets or sets a value to nullify AccessGroupFilter.

public bool? NullifyAccessGroupFilter { get; set; }

Property Value

bool?

bool

Password

Gets or sets the user's password.

public string? Password { get; set; }

Property Value

string

Password

PhoneNumber

Gets or sets the user phone number with space separated country phone code. Example +1 5555555555. Maximum length [20] Default [""]

public string? PhoneNumber { get; set; }

Property Value

string

PhoneNumber

PhoneNumberExtension

Gets or sets the user phone number without formatting. Maximum length [5] Default [""]

public string? PhoneNumberExtension { get; set; }

Property Value

string

PhoneNumberExtension

PrivateUserGroups

Gets or sets the private Group(s) that the user belongs to.

public virtual IList<Group>? PrivateUserGroups { get; set; }

Property Value

IList<Group>

PrivateUserGroups

ReportGroups

Gets or sets the report Group(s) for reporting that this user belongs to. The selected reporting groups will allow the user to sort entities that are children of the selected groups. It will not allow them to see entities that are outside of their data access. Default [empty].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.DisplayUserReportGroups }, IsList = true)]
public virtual IList<Group>? ReportGroups { get; set; }

Property Value

IList<Group>

ReportGroups

SecurityGroups

Gets or sets the security Group(s) this user belongs to; which define the user's access.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.DisplayUserSecurityLevel }, IsList = true)]
public virtual IList<Group>? SecurityGroups { get; set; }

Property Value

IList<Group>

SecurityGroups

ShowClickOnceWarning

Gets or sets a flag indicating whether to show ClickOnce support warning as the default page. (legacy) Default [false].

public bool? ShowClickOnceWarning { get; set; }

Property Value

bool?

ShowClickOnceWarning

TimeZoneId

Gets or sets the IANA Timezone Id of the user. All data will be displayed in this Timezone. Default ["America/New_York"].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserTimeZone })]
public string? TimeZoneId { get; set; }

Property Value

string

TimeZoneId

Remarks

Retrieve a list of valid timezone Id's by querying "GetTimeZones".

UserAuthenticationType

Gets or sets the UserAuthenticationType. This value indicates the type of a user's account. "BasicAuthentication" indicates a basic user. "MyAdmin" indicates a user with MyAdmin credentials. "MyAdmin" users are not visible to "BasicAuthentication" users. Default [Basic].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.UserAuthenticationType })]
public UserAuthenticationType? UserAuthenticationType { get; set; }

Property Value

UserAuthenticationType?

UserAuthenticationType

WifiEULA

Gets or sets a value indicating the user accepted Wifi specific EULA revision number. Default [0].

public int? WifiEULA { get; set; }

Property Value

int?

WifiEULA

WindowsAuthenticationUserId

Gets or sets the windows authentication user Id. This property is so we don't return both User Id and Name to the client side when they have the same value. User Id and Name only differ for WindowsAuthentication users.

[Obsolete("Windows-based authentication is not supported.", false)]
public string? WindowsAuthenticationUserId { get; set; }

Property Value

string

WindowsAuthenticationUserId

ZoneDisplayMode

Gets or sets the default ZoneDisplayMode used on the map. Default [Default].

public ZoneDisplayMode? ZoneDisplayMode { get; set; }

Property Value

ZoneDisplayMode?

ZoneDisplayMode

Methods

Clone()

Creates a new object that is a copy of the current instance.

public override IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.

CreateBasicUser(Id?, long?, string?, string?, string?, string?, string?, string?, string?, DateTime?, DateTime?, IList<Group>?, IList<Group>?, IList<Group>?, ClientSettings?)

Creates a new instance of the User with Basic authentication.

public static User CreateBasicUser(Id? id, long? version, string? login, string? firstName, string? lastName, string? password, string? comment, string? designation, string? employeeNo, DateTime? activeFrom, DateTime? activeTo, IList<Group>? organizationNodes, IList<Group>? reportNodes, IList<Group>? securityNodes, ClientSettings? clientSettings)

Parameters

id Id

The Id.

version long?

The version.

login string

The login (user email).

firstName string

The first name of the user.

lastName string

The last name of the user.

password string

The password.

comment string

The comment.

designation string

The designation.

employeeNo string

The employeeNo.

activeFrom DateTime?

The DateTime from when the User is valid.

activeTo DateTime?

The DateTime to when the User is valid.

organizationNodes IList<Group>

Group collection this user belongs to.

reportNodes IList<Group>

Group collection this user belongs to with only report access.

securityNodes IList<Group>

Group collection that defines what parts of the system the user has access to. The Group(s) are located under the SecurityGroup system Group.

clientSettings ClientSettings

The ClientSettings for this User. When adding the newly created User, ClientSettings can be null and the default settings will be applied.

Returns

User

A new Basic Authentication User.

CreateBasicUser(Id, string, string, string, string, string, string, string, DateTime?, DateTime?, IList<Group>, IList<Group>, IList<Group>, ClientSettings)

Creates a new instance of the User with Basic authentication.

[Obsolete("User CreateBasicUser with version", false)]
public static User CreateBasicUser(Id id, string login, string firstName, string lastName, string password, string comment, string designation, string employeeNo, DateTime? activeFrom, DateTime? activeTo, IList<Group> organizationNodes, IList<Group> reportNodes, IList<Group> securityNodes, ClientSettings clientSettings)

Parameters

id Id

The Id.

login string

The login (user email).

firstName string

The first name of the user.

lastName string

The last name of the user.

password string

The password.

comment string

The comment.

designation string

The designation.

employeeNo string

The employeeNo.

activeFrom DateTime?

The DateTime from when the User is valid.

activeTo DateTime?

The DateTime to when the User is valid.

organizationNodes IList<Group>

Group collection this user belongs to.

reportNodes IList<Group>

Group collection this user belongs to with only report access.

securityNodes IList<Group>

Group collection that defines what parts of the system the user has access to. The Group(s) are located under the SecurityGroup system Group.

clientSettings ClientSettings

The ClientSettings for this User. When adding the newly created User, ClientSettings can be null and the default settings will be applied.

Returns

User

A new Basic Authentication User.

GetAcceptedEULADate()

The date when the EULA was accepted.

public DateTime? GetAcceptedEULADate()

Returns

DateTime?

DateTime The date that the EULA agreement was accepted.

GetClientSettings()

Gets ClientSettings.

public ClientSettings? GetClientSettings()

Returns

ClientSettings

Return ClientSettings of the current User.

GetGroups()

The groups that this user belongs to.

public ReadOnlyCollection<Group> GetGroups()

Returns

ReadOnlyCollection<Group>

The groups.

GetPasswordDateTime()

Gets the date the user set/changed password.

public DateTime? GetPasswordDateTime()

Returns

DateTime?

The date the user set/changed password.

GetPasswordHash()

Gets the password hash.

public string? GetPasswordHash()

Returns

string

The password hash.

GetReportGroups()

Get all reporting groups (excludes security groups).

public ReadOnlyCollection<Group> GetReportGroups()

Returns

ReadOnlyCollection<Group>

A. List<T>

GetSize()

Gets the size estimate of this instance in bytes.

public long GetSize()

Returns

long

Returns the size of the entity.

GetUserId()

Gets the user ID string.

public string? GetUserId()

Returns

string

The user ID string. The userId and Password pair are the User's checkmate credentials. @return. string

IsIdNull(User?)

Checks whether the user or its id is null.

public static bool IsIdNull(User? value)

Parameters

value User

User

Returns

bool

Whether the user's id is null

IsPasswordValid(TimeSpan?)

Returns true if the user's password is valid - neither manually expired nor exceeded the system password lifetime.

public bool IsPasswordValid(TimeSpan? lifetime)

Parameters

lifetime TimeSpan?

The lifetime from system settings.

Returns

bool

True if the user's password is still valid.

PopulateDefaults()

Populate non-required empty (null) properties with default values.

public virtual void PopulateDefaults()

RequiresCertificate()

Check if use has an authenticationType that requires certificate.

public bool RequiresCertificate()

Returns

bool

bool

SetAcceptedEULA(int?)

A value indicating the accepted EULA revision number.

public void SetAcceptedEULA(int? value)

Parameters

value int?

intThe EULA revision number.

SetAcceptedEULADate(DateTime?)

The date when the EULA was accepted.

public void SetAcceptedEULADate(DateTime? value)

Parameters

value DateTime?

The date.

SetClientSettings(ClientSettings)

Set ClientSettings for the User.

public void SetClientSettings(ClientSettings newSettings)

Parameters

newSettings ClientSettings

The new ClientSettings.

SetIsEULAAccepted(int)

a value indicating accepted EULA revision.

public void SetIsEULAAccepted(int value)

Parameters

value int

int The EULA version.

SetPasswordDateTime(DateTime?)

Sets the date the user set/changed password.

public void SetPasswordDateTime(DateTime? value)

Parameters

value DateTime?

The value.

SetPasswordHash(string?)

Sets the password hash.

public void SetPasswordHash(string? value)

Parameters

value string

The value.

SetUserId(string?, bool)

Sets the user ID string. @return The user ID string. The userId and Password pair are the User's checkmate credentials.

public void SetUserId(string? value, bool keepNameAndUserAuthenticationType = false)

Parameters

value string

The value.

keepNameAndUserAuthenticationType bool

Only set userID and do not update other properties.

SetUserName(string?)

Sets the user.Name string.

public void SetUserName(string? value)

Parameters

value string

The name value.

SystemFromId(Id?)

Returns a system User from the provided system Id else null if its a not a system user.

public static User? SystemFromId(Id? id)

Parameters

id Id

The id.

Returns

User

A user derived from the provided id.