Skip to content
Wysp Docs

UserStatePartial

Partial user state

type: object

NameTypeRequiredDescription
languagesarraynoArray of languages spoken by User, in order of descending preference.
unitSystemUnitSystemno
givenNamestringnoThe given name (aka first name / forename / casual spoken name) of the user.
travelModeVEHICLE
VEHICLE:CAGE
VEHICLE:MOTORBIKE
VEHICLE:MOPED
VEHICLE:SPECIAL:BUS
VEHICLE:SPECIAL:HGV
VEHICLE:SPECIAL:HOV
VEHICLE:SPECIAL:EMERGENCY
BICYCLE
BICYCLE:PEDAL
BICYCLE:ELECTRIC
FOOT
noPreferred travel mode
destinationsarray<Destination>noCurrent destinations for the user
planUserStatePlan | nullno
geometryUserStateGeometrynoCurrent location and planned route geometry
statementsarray<Statement>noPlanned statements for the user
toolAvailabilitiesToolAvailabilitiesno
serverServerStatusnoServer-side status for the user