Webportal v2

embedded apps

API Reference - driving.drivingState

Edit
Required Privacy: Data & Location
Operations:
GET
driving.drivingState
Edit

This API allows to work with driver distraction status.

You can retrieve driver distraction disclaimer text with this API.

Note: driverDistraction is set to true under 5 km/h and to false upon 5km/h.

Warning: When driverDistraction is set to false:

  • the app must not display heavy animated elements.
  • the app must not include games or other features outside the intended app types.
Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
drivingState

Driver distraction is set to true when the driver is able to use the infotainment system and to false otherwise.

boolean

n/a

 		true
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12
13

webportal.get(
    /* api name */
    "driving.drivingState",
    /* 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": "driving.drivingState",
  "params":  null
}

1
2
3
4
5
6
7
8
9
10

// --- format of the `REPLY` message ---

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

false

SUBSCRIBE
driving.drivingState
Edit

This API allows to work with driver distraction status.

You can retrieve driver distraction disclaimer text with this API.

Note: driverDistraction is set to true under 5 km/h and to false upon 5km/h.

Warning: When driverDistraction is set to false:

  • the app must not display heavy animated elements.
  • the app must not include games or other features outside the intended app types.
Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
drivingState

Driver distraction is set to true when the driver is able to use the infotainment system and to false otherwise.

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 */
    "driving.drivingState",
    /* 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": "driving.drivingState",
  "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

// --- 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": "driving.drivingState",
  "status": 200,
  "statusText": "OK", 
  "data": true
}

Back to Ref List

Related References