Webportal v2

embedded apps

API Reference - navigation.navSettings

Required Privacy: Always available

This API allows to interact with navigation settings.

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
guidanceViewMode

Select guidance view mode.

boolean

- 0: 3D view

- 1: 2D view direction up

- 2: 2D view direction north
0
autoMapZoomMode

Select ‘auto zoom on map’ mode.

boolean

- 0: Zoom based on the next instruction

- 1: Zoom based on route type

- 2: No auto zoom
0
safetyAlertsDangerZones

Notify danger zones.

boolean

n/a

true
safetyAlertsRiskZones

Notify Risks zone.

boolean

n/a

true
laneGuidanceOnMotorways

Enable lane guidance on motorways.

boolean

n/a

true
liveTrafficOnMap

Notify live traffic.

boolean

n/a

true
nightMode

Enable night mode.

boolean

n/a

true
voiceGuidanceStatus

Enable voice guidance

boolean

n/a

true
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
    /* api name */
    "navigation.navSettings",
    /* parameters */
     null
  )
  /* callback for `REPLY` messages */
  .then((message) => {
    if (message.status === 200) {
      /* handle `REPLY` success */
    }
    else { /* handle `REPLY` error */ }
  })
1
2
3
4
5
6
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0", 
  "type": "GET", 
  "api": "navigation.navSettings",
  "params":  null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "navigation.navSettings",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "guidanceViewMode": 0,
    "autoMapZoomMode": 0,
    "safetyAlertsDangerZones": true,
    "safetyAlertsRiskZones": true,
    "laneGuidanceOnMotorways": true,
    "liveTrafficOnMap": true,
    "nightMode": true,
    "voiceGuidanceStatus": true
  } 
}

false

This API allows to interact with navigation settings.

Input Parameter
Param name Description Type Unit/Values Example Required
voiceGuidanceStatus

Enable voice guidance

boolean

n/a

true true
Output Data
No outputted data
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
webportal.set(
    /* api name */
    "navigation.navSettings",
    /* parameters */
     "voiceGuidanceStatus": false
 
  )
  /* callback for `REPLY` messages */
  .then((message) => {
    if (message.status === 200) {
      /* handle `REPLY` success */
    }
    else { /* handle `REPLY` error */ }
  })
1
2
3
4
5
6
7
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0", 
  "type": "SET", 
  "api": "navigation.navSettings",
  "params":  "voiceGuidanceStatus": false
 
}
1
2
3
4
5
6
7
8
9
// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "navigation.navSettings",
  "status": 200,
  "statusText": "OK"
}

false

This API allows to interact with navigation settings.

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
guidanceViewMode

Select guidance view mode.

boolean

- 0: 3D view

- 1: 2D view direction up

- 2: 2D view direction north
0
autoMapZoomMode

Select ‘auto zoom on map’ mode.

boolean

- 0: Zoom based on the next instruction

- 1: Zoom based on route type

- 2: No auto zoom
0
safetyAlertsDangerZones

Notify danger zones.

boolean

n/a

true
safetyAlertsRiskZones

Notify Risks zone.

boolean

n/a

true
laneGuidanceOnMotorways

Enable lane guidance on motorways.

boolean

n/a

true
liveTrafficOnMap

Notify live traffic.

boolean

n/a

true
nightMode

Enable night mode.

boolean

n/a

true
voiceGuidanceStatus

Enable voice guidance

boolean

n/a

true
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
webportal.subscribe(
    /* api name */
    "navigation.navSettings",
    /* parameters */
     null,
    /* callback for `NOTIFY` messages */
    async (notifyMessage) => {
      if (notifyMessage.status === 200) {
        /* handle `NOTIFY` response */
      }
      else { /*  handle `NOTIFY` error  */ }
    }
  )
  /* callback for `REPLY` messages */
  .then((message) => {
    if (message.status === 200) {
      /* handle `REPLY` success */
    }
    else { /* handle `REPLY` error */ }
  })
1
2
3
4
5
6
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0", 
  "type": "SUBSCRIBE", 
  "api": "navigation.navSettings",
  "params":  null
}
1
2
3
4
5
6
7
8
9
10
11
// --- format of the `REPLY` message ---
// type: acknowledge the status of the subscription
// reception: only once after the subscription request
// contains outputed data: no
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "status": 200,
  "statusText": "OK"
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// --- format of the `NOTIFY` message ---
// type: event message about the subscription
// reception: each time the conditions of the subscription are met
// contains outputed data: yes
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "NOTIFY",
  "api": "navigation.navSettings",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "guidanceViewMode": 0,
    "autoMapZoomMode": 0,
    "safetyAlertsDangerZones": true,
    "safetyAlertsRiskZones": true,
    "laneGuidanceOnMotorways": true,
    "liveTrafficOnMap": true,
    "nightMode": true,
    "voiceGuidanceStatus": true
  } 
}