User (java-sdk 9.0.1 API)

java.lang.Object
- com.geotab.model.entity.Entity
- - com.geotab.model.entity.NameEntity
  - - com.geotab.model.entity.NameEntityWithVersion
    - - com.geotab.model.entity.user.User

Direct Known Subclasses:

Driver, NoUser, SystemUser
```
public class User
extends NameEntityWithVersion
```
A user of the system. A user can be a MyGeotab user or a user that is a Driver.

Nested Class Summary
- Nested classes/interfaces inherited from class com.geotab.model.entity.Entity
  Entity.EntityBuilder<C extends Entity,B extends Entity.EntityBuilder<C,B>>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`acceptedEULA` A value indicating the user accepted EULA revision number.
`protected List<String>`	`activeDashboardReports` The active dashboard reports.
`protected LocalDateTime`	`activeFrom` The date the user is active from.
`protected LocalDateTime`	`activeTo` The date the user is active to.
`protected String`	`authorityAddress` The HOS authority address of the user.
`protected String`	`authorityName` The HOS authority name of the user.
`protected List<String>`	`availableDashboardReports` List of all available dashboard reports to the user.
`protected List<String>`	`bookmarks` The list of bookmarked pages.
`protected String[][]`	`cannedResponseOptions` The user's stored list of custom response options to choose from when sending a TextMessage.
`protected String`	`carrierNumber` The carrier number.
`protected Boolean`	`changePassword` Flag indicating whether the user's password requires resetting.
`protected String`	`comment` Free text field where any user information can be stored and referenced for this entity.
`protected String`	`companyAddress` The company address for the user.
`protected List<Group>`	`companyGroups` List of organization `Group`(s) that the user belongs to.
`protected String`	`companyName` The name of the company for the user.
`protected String`	`countryCode` The user two symbols country ISO code (https://www.iso.org/iso-3166-country-codes.html).
`protected String`	`dateFormat` The format dates will be displayed to this user.
`protected GoogleMapStyle`	`defaultGoogleMapStyle` The default map style for Google maps.
`protected HereMapStyle`	`defaultHereMapStyle` The default map style for Here Maps.
`protected String`	`defaultMapEngine` The default map engine to use for this user.
`protected OpenStreetMapStyle`	`defaultOpenStreetMapStyle` The default map style for Open Street Maps.
`protected String`	`defaultPage` Indicates the default page to view when login complete.
`protected String`	`designation` The designation or title of the employee.
`protected Currency`	`displayCurrency` Gets or sets the user's preferred currency for display in the UI.
`protected Integer`	`driveGuideVersion` The version of the last drive what's new guide viewed by the user.
`protected ElectricEnergyEconomyUnit`	`electricEnergyEconomyUnit` The user's preferred `ElectricEnergyEconomyUnit` for viewing fuel economy.
`protected String`	`employeeNo` The employee number or external identifier.
`protected DayOfWeek`	`firstDayOfWeek` The user's preferred day to represent the start of the week.
`protected String`	`firstName` The first name of the user.
`protected FuelEconomyUnit`	`fuelEconomyUnit` The user's preferred `FuelEconomyUnit` for viewing fuel economy.
`protected HosRuleSet`	`hosRuleSet` The `HosRuleSet` the user follows.
`protected Boolean`	`isDriver` The is driver toggle, if [true] the user is a driver, otherwise [false].
`protected Boolean`	`isEmailReportEnabled` If [true] the user will receive the emailed report, otherwise [false].
`protected Boolean`	`isEULAAccepted` Value indicating whether the old EULA has been accepted by the end user.
`protected Boolean`	`isExemptHOSEnabled` Value indicating whether the user is allowed to HOS personal conveyance.
`protected Boolean`	`isLabsEnabled` Value indicating whether labs are enabled for this user.
`protected Boolean`	`isMetric` Whether the current regional settings is in metric units of measurement (or US/Imperial).
`protected Boolean`	`isNewsEnabled` Value that indicates whether news notifications are enabled for this user.
`protected Boolean`	`isPersonalConveyanceEnabled` Value indicating whether the user is allowed to HOS personal conveyance.
`protected Boolean`	`isServiceUpdatesEnabled` Value indicating whether are service update notifications enabled for this user.
`protected Certificate`	`issuerCertificate` The issuer certificate for the user.
`protected Boolean`	`isYardMoveEnabled` Value indicating whether the user is allowed to HOS yard move.
`protected String`	`language` The user's language.
`protected LocalDateTime`	`lastAccessDate` The user's Last access date of the system.
`protected String`	`lastName` The last name of the user.
`protected List<MapView>`	`mapViews` The list of the of the available `MapView`s from the live map.
`protected Double`	`maxPCDistancePerDay` Value indicating the maximum personal conveyance distance per day in meters.
`protected String`	`password` The user's password.
`protected String`	`phoneNumber` The user phone number with space separated country phone code.
`protected String`	`phoneNumberExtension` The user phone number without formatting.
`protected List<Group>`	`privateUserGroups` The private `Group`(s) that the user belongs to.
`protected List<Group>`	`reportGroups` The report `Group`(s) for reporting that this user belongs to.
`protected List<Group>`	`securityGroups` The security `Group`(s) this user belongs to; which define the user's access.
`protected Boolean`	`showClickOnceWarning` A flag indicating whether to show ClickOnce support warning as the default page.
`protected String`	`timeZoneId` The IANA time zone Id of the user.
`protected UserAuthenticationType`	`userAuthenticationType` The user authentication type.
`protected Integer`	`wifiEULA` Value indicating accepted WiFi-specific EULA version.
`protected ZoneDisplayMode`	`zoneDisplayMode` The default zone display mode used on the map.

Constructor Summary

Constructors
Constructor and Description

User(String id)

Constructors
Constructor and Description
`User(String id)`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static User fromSystem(String id)
- Methods inherited from class com.geotab.model.entity.Entity
  addExtraProperty, getExtraProperties, isSystemEntity
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static User`	`fromSystem(String id)`

- Field Detail
  - acceptedEULA
```
protected Integer acceptedEULA
```
    A value indicating the user accepted EULA revision number. Default [0].
  - driveGuideVersion
```
protected Integer driveGuideVersion
```
    The version of the last drive what's new guide viewed by the user. Default [0].
  - wifiEULA
```
protected Integer wifiEULA
```
    Value indicating accepted WiFi-specific EULA version. Default [0].
  - activeDashboardReports
```
protected List<String> activeDashboardReports
```
    The active dashboard reports. Default [empty].
  - bookmarks
```
protected List<String> bookmarks
```
    The list of bookmarked pages. Default [empty].
  - activeFrom
```
protected LocalDateTime activeFrom
```
    The date the user is active from. Default [UtcNow].
  - activeTo
```
protected LocalDateTime activeTo
```
    The date the user is active to. Default [MaxDate].
  - availableDashboardReports
```
protected List<String> availableDashboardReports
```
    List of all available dashboard reports to the user. Default [empty].
  - cannedResponseOptions
```
protected String[][] cannedResponseOptions
```
    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].
  - changePassword
```
protected Boolean changePassword
```
    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].
  - comment
```
protected String comment
```
    Free text field where any user information can be stored and referenced for this entity. Default [""].
  - companyGroups
```
protected List<Group> companyGroups
```
    List of organization Group(s) that the user belongs to.
  - dateFormat
```
protected String dateFormat
```
    The format dates will be displayed to this user. Default ["MM/dd/yy HH:mm:ss"].
  - phoneNumber
```
protected String phoneNumber
```
    The user phone number with space separated country phone code. Example +1 5555555555. Maximum length [20] Default [""]
  - displayCurrency
```
protected Currency displayCurrency
```
    Gets or sets the user's preferred currency for display in the UI.
  - countryCode
```
protected String countryCode
```
    The user two symbols country ISO code (https://www.iso.org/iso-3166-country-codes.html). Maximum length [2] Default [""]
  - phoneNumberExtension
```
protected String phoneNumberExtension
```
    The user phone number without formatting. Maximum length [5] Default [""]
  - defaultGoogleMapStyle
```
protected GoogleMapStyle defaultGoogleMapStyle
```
    The default map style for Google maps. Default [Roadmap].
  - defaultMapEngine
```
protected String defaultMapEngine
```
    The default map engine to use for this user. System map engines are:
    - GoogleMaps
    - HereMap
    - MapBox
    Default ["MapBox"].
  - defaultOpenStreetMapStyle
```
protected OpenStreetMapStyle defaultOpenStreetMapStyle
```
    The default map style for Open Street Maps. Default [MapBox].
  - defaultHereMapStyle
```
protected HereMapStyle defaultHereMapStyle
```
    The default map style for Here Maps. Default [Roadmap].
  - defaultPage
```
protected String defaultPage
```
    Indicates the default page to view when login complete. Maps to the hash portion of the web site URL (https://url/enpoint/[#page]). Default [helpGuide].
  - designation
```
protected String designation
```
    The designation or title of the employee. Maximum length [50] Default [""].
  - employeeNo
```
protected String employeeNo
```
    The employee number or external identifier. Maximum length [50] Default [""].
  - firstName
```
protected String firstName
```
    The first name of the user. Maximum length [255].
  - fuelEconomyUnit
```
protected FuelEconomyUnit fuelEconomyUnit
```
    The user's preferred FuelEconomyUnit for viewing fuel economy. Default [FuelEconomyUnit.LITERS_PER_100_KM].
  - electricEnergyEconomyUnit
```
protected ElectricEnergyEconomyUnit electricEnergyEconomyUnit
```
    The user's preferred ElectricEnergyEconomyUnit for viewing fuel economy. Default [ElectricEnergyEconomyUnit.LITERS_E_PER_100_KM].
  - hosRuleSet
```
protected HosRuleSet hosRuleSet
```
    The HosRuleSet the user follows. Default [HosRuleSet.NONE].
  - isYardMoveEnabled
```
protected Boolean isYardMoveEnabled
```
    Value indicating whether the user is allowed to HOS yard move. Default [false].
  - isPersonalConveyanceEnabled
```
protected Boolean isPersonalConveyanceEnabled
```
    Value indicating whether the user is allowed to HOS personal conveyance. Default [false].
  - isExemptHOSEnabled
```
protected Boolean isExemptHOSEnabled
```
    Value indicating whether the user is allowed to HOS personal conveyance. Default [false].
  - maxPCDistancePerDay
```
protected Double maxPCDistancePerDay
```
    Value indicating the maximum personal conveyance distance per day in meters. Default [0].
  - authorityName
```
protected String authorityName
```
    The HOS authority name of the user. Default [""].
  - authorityAddress
```
protected String authorityAddress
```
    The HOS authority address of the user. Default [""].
  - isEULAAccepted
```
protected Boolean isEULAAccepted
```
    Value indicating whether the old EULA has been accepted by the end user. Default [false].
  - isNewsEnabled
```
protected Boolean isNewsEnabled
```
    Value that indicates whether news notifications are enabled for this user. Default [true].
  - isServiceUpdatesEnabled
```
protected Boolean isServiceUpdatesEnabled
```
    Value indicating whether are service update notifications enabled for this user. Default [false].
  - isLabsEnabled
```
protected Boolean isLabsEnabled
```
    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].
  - isMetric
```
protected Boolean isMetric
```
    Whether the current regional settings is in metric units of measurement (or US/Imperial). Default [true].
  - language
```
protected String language
```
    The user's language. Default: ["en"] for English.
  - firstDayOfWeek
```
protected DayOfWeek firstDayOfWeek
```
    The user's preferred day to represent the start of the week. Default ["Sunday"].
  - lastName
```
protected String lastName
```
    The last name of the user. Maximum length [255].
  - mapViews
```
protected List<MapView> mapViews
```
    The list of the of the available MapViews from the live map. Default [continent of the user's selected time zone].
  - password
```
protected String password
```
    The user's password.
  - privateUserGroups
```
protected List<Group> privateUserGroups
```
    The private Group(s) that the user belongs to.
  - reportGroups
```
protected List<Group> reportGroups
```
    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].
  - securityGroups
```
protected List<Group> securityGroups
```
    The security Group(s) this user belongs to; which define the user's access.
  - showClickOnceWarning
```
protected Boolean showClickOnceWarning
```
    A flag indicating whether to show ClickOnce support warning as the default page. (legacy) Default [false].
  - timeZoneId
```
protected String timeZoneId
```
    The IANA time zone Id of the user. All data will be displayed in this time zone. Default ["America/New_York"].
  - userAuthenticationType
```
protected UserAuthenticationType userAuthenticationType
```
    The user authentication type. Default [Basic].
  - zoneDisplayMode
```
protected ZoneDisplayMode zoneDisplayMode
```
    The default zone display mode used on the map. Default [Default].
  - issuerCertificate
```
protected Certificate issuerCertificate
```
    The issuer certificate for the user. Will only be populated for users not using basic authentication.
  - companyName
```
protected String companyName
```
    The name of the company for the user. Default [""].
  - companyAddress
```
protected String companyAddress
```
    The company address for the user. Default [""].
  - carrierNumber
```
protected String carrierNumber
```
    The carrier number. Default [""].
  - lastAccessDate
```
protected LocalDateTime lastAccessDate
```
    The user's Last access date of the system.
  - isDriver
```
protected Boolean isDriver
```
    The is driver toggle, if [true] the user is a driver, otherwise [false]. Default [false].
  - isEmailReportEnabled
```
protected Boolean isEmailReportEnabled
```
    If [true] the user will receive the emailed report, otherwise [false]. Default [true].
- Constructor Detail
  - User
```
public User(String id)
```
- Method Detail
  - fromSystem
```
public static User fromSystem(String id)
```

Class User

Nested Class Summary

Nested classes/interfaces inherited from class com.geotab.model.entity.Entity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.geotab.model.entity.Entity

Methods inherited from class java.lang.Object

Field Detail

acceptedEULA

driveGuideVersion

wifiEULA

activeDashboardReports

bookmarks

activeFrom

activeTo

availableDashboardReports

cannedResponseOptions

changePassword

comment

companyGroups

dateFormat

phoneNumber

displayCurrency

countryCode

phoneNumberExtension

defaultGoogleMapStyle

defaultMapEngine

defaultOpenStreetMapStyle

defaultHereMapStyle

defaultPage

designation

employeeNo

firstName

fuelEconomyUnit

electricEnergyEconomyUnit

hosRuleSet

isYardMoveEnabled

isPersonalConveyanceEnabled

isExemptHOSEnabled

maxPCDistancePerDay

authorityName

authorityAddress

isEULAAccepted

isNewsEnabled

isServiceUpdatesEnabled

isLabsEnabled

isMetric

language

firstDayOfWeek

lastName

mapViews

password

privateUserGroups

reportGroups

securityGroups

showClickOnceWarning

timeZoneId

userAuthenticationType

zoneDisplayMode

issuerCertificate

companyName

companyAddress

carrierNumber

lastAccessDate

isDriver

isEmailReportEnabled

Constructor Detail

User

Method Detail

fromSystem