Mobile SDK

iOS or Android

API Reference - pims.sdk.token-registerPushToken

Info: Stellantis Mobile SDK is not publicly available.
Tutorial: check-out Push Notification.
SDK Version: v2.3
API Available since: v2.1
API Last update: v2.1
Plateforme Compatibility: PSA
Security:
  • Authentication: Authentication is required.
Operations:

Register a push notification token.

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

Action Name, in this case registerPushToken.

String

registerPushToken

registerPushToken true
token

FireBase token.

String

n/a

true
Output Data Object
No outputted data
Error
No errors
Code Example
1
2
3
4
5
6
7
8
9
10
pims.set("pims.sdk.token",
  mapOf( /* parameters */  
    Pair("action", "registerPushToken"),
    Pair("token", "<token>")
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }
1
2
3
4
5
6
7
8
9
10
pims.set(api: "pims.sdk.token",
  parameters: [  
    "action": "registerPushToken",
    "token": "<token>"
  ]
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // 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": { }
}

false