METHOD_TerminateSession

This method sends a notification to BEMS that the user has ended the chat session or logged out of the BlackBerry Connect app.

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

Parameter

Type

 Required

Description

dependencies

String

 —

This parameter specifies the other methods that this method is dependent on. It specifies the comma delimited dependent request IDs.
reconnect String — This parameter specifies that the BlackBerry Connect app re-establish the existing session. For example, if BlackBerry Connect goes to the background, when it comes to the foreground the same session is continued.

BEMS response and notification

The following table describes the parameters that BEMS that returns and the notification to send to the BlackBerry Connect app when the user ends a session.

Parameter

Type

Description

method

String

This parameter specifies the invoked method (for example, TerminateSession).
state String This parameter specifies the state of the request to BEMS (for example, Processing or Complete).

Code sample

The following example sends a notification to BEMS that the user is ending the chat session or logging out of the BlackBerry Connect app.

{
  "method":"TerminateSession",
  "params":{},
  "id":"c12",
  "jsonrpc":"2.0"
}

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

{
  "id":"c12",
  "error":null,
  "result":
   {
    "data":
     {
      "method":"TerminateSession",
      "state":"COMPLETE"
     }
   },
  "jsonrpc":"2.0"
  "background":false
}
If there are no errors, BEMS sends the following notification to the BlackBerry Connect app and the user ends the chat session or logs out of the app. 
{
 "id": "c12",
 "sequence":1018699100000067,
 "result": 
  {
   "data": 
    {
     "method":"TerminateSession",
     "state":"COMPLETE"
    }
  },
 "jsonrpc":"2.0"
}