bootstrap

bootstrap

On socket initialization, the server sends a bootstrap containing tool definitions and the user state object. The client should hold the state object in memory, merging in deltas over time as they arrive in state.delta messages

Data Schema

type: object

Properties

Name	Type	Required	Description
state	object	yes	User state
toolDefinitions	object[]	yes	List of all Tools that may be available in this session

Example

{
  "kind": "bootstrap",
  "data": {
    "state": {
      "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"
      }
    },
    "toolDefinitions": []
  }
}