state.delta

state.delta

Changes to be merged into the in-memory state object

Data Schema

type: object

Properties

Name	Type	Required	Description
languages	string[]	no	Array of languages spoken by User, in order of descending preference.
unitSystem	string	no	Preferred unit system for measurements
givenName	string	no	The given name (aka first name / forename / casual spoken name) of the user.
travelMode	string	no	Preferred travel mode
destinations	object[]	no	Current destinations for the user
plan	object | null	no
geometry	object	no	GeoJSON describing the user’s current position and planned routes.
statements	object[]	no	Planned statements for the user
toolAvailabilities	string[]	no	List of Tool IDs, for tools that are currently available and relevant
server	object	no	Metadata about the current state of the server from the user’s perspective

Example

{
  "kind": "state.delta",
  "data": {
    "languages": [
      "en-US",
      "nb-NO"
    ],
    "unitSystem": "LOCAL",
    "givenName": "Marius",
    "travelMode": "FOOT",
    "destinations": [
      {
        "name": "Home"
      }
    ],
    "plan": {
      "durationSeconds": 852,
      "distanceMeters": 600
    },
    "geometry": {
      "fix": null,
      "triggers": {},
      "routeLines": [],
      "routePoints": []
    },
    "statements": [
      {
        "id": "c04dd717-7e2c-434d-8d31-2f7268e5b51b",
        "transcript": "Turn left at the roundabout.",
        "locale": "en-US",
        "clipId": "18905e54-0091-4e3a-90f7-58d1dcecb913",
        "trigger": {
          "kind": "LOCATION",
          "lat": 37.7749,
          "lng": -122.4194,
          "heading": 90
        }
      }
    ],
    "toolAvailabilities": [
      "string"
    ],
    "server": {
      "isPlanning": false,
      "errorMessage": null,
      "dataAvailability": "FULL"
    }
  }
}