Table of Contents

Class ClientSettings

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

Settings that apply to client application.

public class ClientSettings : Entity, IEntity, IComparable, IIdentifiable, IDefaultable, IInstanceSizeEstimate
Inheritance
ClientSettings
Implements
Inherited Members

Constructors

ClientSettings()

Initializes a new instance of the ClientSettings class. Initializes a new instance of the ClientSettings class.

public ClientSettings()

Fields

DefaultTimezone

The default TimeZone.

public const string DefaultTimezone = "America/New_York"

Field Value

string

Properties

AcceptedEULA

Gets or sets a value indicating accepted EULA revision.

public int? AcceptedEULA { get; set; }

Property Value

int?

int

AcceptedEULADate

Gets or sets the date when the EULA was accepted.

public DateTime? AcceptedEULADate { get; set; }

Property Value

DateTime?

DateTime

ActiveDashboardReports

Gets or sets the dashboard reports. Ordered and added to the dashboard page by user reports.

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

Property Value

string[]

array of. string

ActiveDefaultDashboards

Gets or sets the list of default dashboards which must show real data.

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

Property Value

string[]

array of. string

AuthorityAddress

Gets or sets the authority address.

public string? AuthorityAddress { get; set; }

Property Value

string

The authority address.

AuthorityName

Gets or sets the name of the authority.

public string? AuthorityName { get; set; }

Property Value

string

The name of the authority.

AvailableDashboardReports

Gets or sets the dashboard reports. All available for an user dashboard reports.

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

Property Value

string[]

array of. string

Bookmarks

Gets or sets the list of bookmarked pages.

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

Property Value

string[]

array of. string

CannedResponseOptions

Gets or sets allowed responses to a GPSTextMessage.

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

Property Value

string[][]

array of array of. string

CarrierNumber

Gets or sets the carrier number.

public string? CarrierNumber { get; set; }

Property Value

string

The carrier number.

ChangePassword

Gets or sets a value indicating whether indicates whether the password requires resetting.

public bool? ChangePassword { get; set; }

Property Value

bool?

true if [change password]; otherwise, false.

CompanyAddress

Gets or sets the company address.

public string? CompanyAddress { get; set; }

Property Value

string

The company address.

CompanyName

Gets or sets the name of the company.

public string? CompanyName { get; set; }

Property Value

string

The name of the company.

CountryCode

Gets or sets user country code.

public string? CountryCode { get; set; }

Property Value

string

User country code string.

DateFormat

Gets or sets date format.

public string? DateFormat { get; set; }

Property Value

string

The date format.

DefaultGoogleMapStyle

Gets or sets the default map style for Google maps.

public GoogleMapStyle? DefaultGoogleMapStyle { get; set; }

Property Value

GoogleMapStyle?

GoogleMapStyle

DefaultHereMapStyle

Gets or sets the default map style for Here maps.

public HereMapStyle? DefaultHereMapStyle { get; set; }

Property Value

HereMapStyle?

HereMapStyle

DefaultMapEngine

Gets or sets the default map engine.

public string? DefaultMapEngine { get; set; }

Property Value

string

string

DefaultOpenStreetMapStyle

Gets or sets the default map style for open street maps.

public OpenStreetMapStyle? DefaultOpenStreetMapStyle { get; set; }

Property Value

OpenStreetMapStyle?

OpenStreetMapStyle

DefaultPage

Gets or sets indicates the default page to view when login complete.

public string? DefaultPage { get; set; }

Property Value

string

string

DisplayCurrency

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

public Currency? DisplayCurrency { get; set; }

Property Value

Currency?

User's preferred currency Currency.

DriveGuideVersion

Gets or sets the version of the last drive what's new guide viewed by the user.

public int? DriveGuideVersion { get; set; }

Property Value

int?

int

ElectricEnergyEconomyUnit

Gets or sets Electric Energy Economy Unit.

public ElectricEnergyEconomyUnit? ElectricEnergyEconomyUnit { get; set; }

Property Value

ElectricEnergyEconomyUnit?

ElectricEnergyEconomyUnit

FeaturePreview

Gets or sets list of features enabled to preview.

public string? FeaturePreview { get; set; }

Property Value

string

The authority address.

FirstDayOfWeek

Gets or sets the first day of the calendar week.

public DayOfWeek? FirstDayOfWeek { get; set; }

Property Value

DayOfWeek?

DayOfWeek

FuelEconomyUnit

Gets or sets fuel Economy Unit.

public FuelEconomyUnit? FuelEconomyUnit { get; set; }

Property Value

FuelEconomyUnit?

FuelEconomyUnit

IsAdverseDrivingEnabled

Gets or sets a value indicating whether the user is allowed to use Adverse driving conditions exempt.

public bool? IsAdverseDrivingEnabled { get; set; }

Property Value

bool?

A value indicating whether the user is allowed to use Adverse driving conditions exempt.

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

IsExemptHOSEnabled

Gets or sets a value indicating whether the user is allowed to use Exempt HOS.

public bool? IsExemptHOSEnabled { get; set; }

Property Value

bool?

A value indicating whether the user is allowed to use Exempt HOS.

IsLabsEnabled

Gets or sets a value indicating whether are labs enabled for this user. When [true] this will enable experimental features that aren't quite ready for production.

public bool? IsLabsEnabled { get; set; }

Property Value

bool?

bool

IsMetric

Gets or sets a value indicating whether gets a value indicating whether the current regional settings is in Metric.

public bool? IsMetric { get; set; }

Property Value

bool?

bool

IsNewsEnabled

Gets or sets a value indicating whether are news notifications enabled for this user.

public bool? IsNewsEnabled { get; set; }

Property Value

bool?

bool

IsPersonalConveyanceEnabled

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

public bool? IsPersonalConveyanceEnabled { get; set; }

Property Value

bool?

A value indicating whether the user is allowed to HOS personal conveyance.

IsYardMoveEnabled

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

public bool? IsYardMoveEnabled { get; set; }

Property Value

bool?

A value indicating whether the user is allowed to HOS yard move.

JobPriorities

Gets or sets the list of selected job priorities.

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

Property Value

string[]

array of. string

Language

Gets or sets the users language.

public string? Language { get; set; }

Property Value

string

The language abbreviation same as Google translate.

MapViews

Gets or sets the map views. The Map Views are named extents and allows.

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

Property Value

List<MapView>

The map views.

MapViewsInternal

Gets or sets the map views. The Map Views are named extents and allows Designed for internal application use. Use MapViews instead.

public MapView[]? MapViewsInternal { get; set; }

Property Value

MapView[]

The array of MapView.

MaxPCDistancePerDay

Gets or sets a value indicating the maximum personal conveyance limit per day

public double? MaxPCDistancePerDay { get; set; }

Property Value

double?

A value indicating the maximum personal conveyance limit per day

PhoneNumber

Gets or sets user phone number.

public string? PhoneNumber { get; set; }

Property Value

string

User phone number string.

PhoneNumberExtension

Gets or sets an extension telephone.

public string? PhoneNumberExtension { get; set; }

Property Value

string

An extension telephone string.

ShareableLinkEULA

Gets or sets a last version of shareable link version that the client accepted . Default [null].

public int? ShareableLinkEULA { get; set; }

Property Value

int?

ShareableLinkEULA

ShowClickOnceWarning

Gets or sets a value indicating whether to show ClickOnce support warning as the default page.

public bool? ShowClickOnceWarning { get; set; }

Property Value

bool?

bool

TimeZoneId

Gets or sets the user Timezone ID.

public string? TimeZoneId { get; set; }

Property Value

string

string

WifiEULA

Gets or sets a value indicating accepted WiFi-specific EULA version.

public int? WifiEULA { get; set; }

Property Value

int?

int

ZoneDisplayMode

Gets or sets the zone display mode.

public ZoneDisplayMode? ZoneDisplayMode { get; set; }

Property Value

ZoneDisplayMode?

The zone display mode.

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.

CloneClientSettings()

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

[Obsolete("Use Clone.")]
public ClientSettings CloneClientSettings()

Returns

ClientSettings

A new object that is a copy of this instance.

Equals(object?)

Determines whether the specified is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object .

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as a hash function for a particular type. hashCode() is suitable for use in hashing algorithms and data structures like a hash table.

public override int GetHashCode()

Returns

int

A hash code for the current object.

GetSize()

Gets the size estimate of this instance in bytes.

public long GetSize()

Returns

long

Returns the size of the entity.

PopulateDefaults()

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

public void PopulateDefaults()

WithDefaultsPopulated()

Initializes a new instance of the ClientSettings class with default values.

public static ClientSettings WithDefaultsPopulated()

Returns

ClientSettings

A new ClientSettings object with default values.