Mobile SDK

iOS or Android

    API Reference - pims.vehicle.timeout

    Info: Stellantis Mobile SDK for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is not publicly available for now.
    Available since: v2.0.X
    Component: O2X
    Security: Authentication is not required.
    Operation:

    This API allows to set 02X timeouts.

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

    Timeout that will be triggered if no vehicle found after the specified time. The default value is 60 seconds (60000 ms).

    Long

    false
    looseConnection

    The timeout that will be triggered if no data received after the specified time. The default value is 5 seconds (5000 ms).

    Long

    false
    changeStatus

    Delay before send notification of change status.

    Long

    false
    Output Data
    No data
    Error
    Error Code Error Label
    2001

    Facade not initialized

    2102

    Invalid [PARAMETER] parameter

    Code Example
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    
    pims.set("pims.vehicle.timeout",
      mapOf( /* parameters */  
        Pair("scan", " "),
        Pair("looseConnection", " "),
        Pair("changeStatus", " ")
      ) 
    ) { 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.timeout",
      parameters: [  
      "scan": " ",
      "looseConnection": " ",
      "changeStatus": " "
      ]
      ) { (message) in 
        if message["status"] == "SUCEEDED"    { }    // handle succeeded status
        else if message["status"] == "FAILED" { }    // handle failed status
      } 
    
    1
    2
    3
    4
    5
    6
    
    // representation of the `succeeded` dictionary object message as JSON
    {
      "transactionId": "953cfefb-bc72",
      "status": "SUCCEEDED",
      "result": null
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    
    // representation of the `failed` dictionary objects messages as JSON
    
    /* -------- STATUS FAILED: 2001 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2001,
        "label": "Facade not initialized"
      }
    }
    /* -------- STATUS FAILED: 2102 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2102,
        "label": "Invalid [PARAMETER] parameter"
      }
    }