METHOD_SetGDToken

Use this method to set the BlackBerry Dynamics access token.

The following table describes the parameters that you can include in this method.

Parameter

Type

Required

Description

gdToken

* Use this parameter if you are using the API version 2.2 or earlier.

String

√

This parameter specifies the BlackBerry Dynamics token that the BlackBerry Connect app retrieves from the proxy server and presents it to BEMS for authentication.
dependenciesString—This parameter specifies the other methods that this method is dependent on. It specifies the comma delimited dependent request IDs.
reconnectString—This parameter specifies that the BlackBerry Connect app re-establish the existing session. For example, if BlackBerry Connect goes to the background and returns to the foreground, the same session is continued.

BEMS response and notification

The following table describes the parameters that BEMS returns and the notification that is sent to the BlackBerry Connect app when a token is set.

Parameter

Type

Description

method

String

This parameter returns the invoked method (for example, SetGDToken).

stateString This parameter specifies the state of the request to BEMS (for example, Processing or Complete).

Code example

The following example sends a request to BEMS to begin an instant messaging chat session.

{
  "id":"c112",
  "method":"SetGDToken",
  "params":
    {
      "SetGDToken":"d64a57b7-f5b5-4e3a-839b-00618653a090"
    },
  "jsonrpc":"2.0"
}

If the request is successful, BEMS sends the following response and token to the BlackBerry Connect app.

{
  "id":"c112",
  "method":"SetGDToken",
  "result":
    {
      "status":"success"       
    },
  "state":"COMPLETE"
  "jsonrpc":"2.0"
}