Webportal v2

embedded apps

API Reference - navigation.destinationReached

Edit
Required Privacy: Always available
Operation:
SUBSCRIBE
navigation.destinationReached
Edit

This API allows to work with reached navigation event.

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

Uniq ID of this navigation.

int

identifier

 		42
destinationReachedAt

Timestamp (second, UTC timezone) expressing the time when the destination has been reached. If null, the navigation has been stoped without reaching the destination.

int

timestamp

 		1577833200
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.destinationReached",
    /* 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.destinationReached",
  "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

// --- 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.destinationReached",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "navRequestId": 42,
    "destinationReachedAt": 1577833200
  } 
}

Back to Ref List

Related References