Skip to content
Wysp Docs

UserStateInput

User state input

type: object

NameTypeRequiredDescription
languagesarrayyesArray of languages spoken by User, in order of descending preference.
unitSystemUnitSystemyes
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
yesPreferred travel mode
destinationsarray<PresenceObjective>yesCurrent destination objectives for the user