UserState
User state
type: object
Properties
Section titled “Properties”| Name | Type | Required | Description |
|---|---|---|---|
languages | array | yes | Array of languages spoken by User, in order of descending preference. |
unitSystem | UnitSystem | yes | |
givenName | string | no | The given name (aka first name / forename / casual spoken name) of the user. |
travelMode | VEHICLE VEHICLE:CAGE VEHICLE:MOTORBIKE VEHICLE:MOPED VEHICLE:SPECIAL:BUS VEHICLE:SPECIAL:HGV VEHICLE:SPECIAL:HOV VEHICLE:SPECIAL:EMERGENCY BICYCLE BICYCLE:PEDAL BICYCLE:ELECTRIC FOOT | yes | Preferred travel mode |
destinations | array<Destination> | yes | Current destinations for the user |
plan | UserStatePlan | null | yes | |
geometry | UserStateGeometry | yes | Current location and planned route geometry |
statements | array<Statement> | yes | Planned statements for the user |
toolAvailabilities | ToolAvailabilities | yes | |
server | ServerStatus | yes | Server-side status for the user |