Mobile SDK

iOS or Android

API Reference - pims.vehicle.destination-extension

Info: Stellantis Mobile SDK is not publicly available.
Tutorial: check-out Send Navigation.
SDK Version: v2.3
API Available since: v2.0
API Last update: v2.3 Updated API!
Plateforme Compatibility: PSA
Security:
  • Authentication: Authentication is required.
Operations:

This api allows sending destination (using Extension) from the mobile phone to the vehicle.

This API is available only if privacy is set to none, check-out pims.vehicle.privacy.

Input Parameters Object
Param name Description Type Unit/Values Example Required
action

Name of the action to perform, in this case extension.

String

extension

extension true
preserve

If this parameter is true, the navigation will be send as soon as the vehicle is connected. Otherwise it will only try once.

Boolean

n/a

true true
extensionInformation

The link of address get from external app (Apple Maps, Google Maps, Here WeGo, Waze & Whats3Words).

String

link

https://goo.gl/maps/8VPNW6yTfHgPPqb16 false
Output Data Object
Data name Description Type Unit/Values Example
status

Indicates the status of request.

Enum of Strings

- notAvailable

- sent

- stored
sent
reason

Description of the failure reason.

String

- GEOLOC_PRIVATE

- FULL_PRIVATE
GEOLOC_PRIVATE
Error
No errors
Code Example
1
2
3
4
5
6
7
8
9
10
11
pims.set("pims.vehicle.destination",
  mapOf( /* parameters */  
    Pair("action", "extension"),
    Pair("preserve", true),
    Pair("extensionInformation", "https://goo.gl/maps/8VPNW6yTfHgPPqb16")
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }
1
2
3
4
5
6
7
8
9
10
11
pims.set(api: "pims.vehicle.destination",
  parameters: [  
    "action": "extension",
    "preserve": true,
    "extensionInformation": "https://goo.gl/maps/8VPNW6yTfHgPPqb16"
  ]
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
  } 
1
2
3
4
5
6
7
8
9
// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": {
    "status": "sent",
    "reason": "GEOLOC_PRIVATE"
  }
}

false