METHOD_StopTyping

This method sends a notification to BEMS when the user stopped typing a message in the chat.

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

Parameter

Type

 Required

Description

contactId

String

 √

This parameter specifies the sip address of the user that is typing the message.

chatId

String

 √

This parameter specifies the unique identifier for the chat session.

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 returns and the notification to send to the BlackBerry Connect app when the user stops typing in the chat session.

Parameter

Type

Description

method

String

This parameter specifies the method invoked (for example, StopTyping).

state

String

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

Code sample

The following code example sends a notification to BEMS and the notification to send to the BlackBerry Connect app when the user stops typing a message.

{
    "id":"c12",
    "method":"StopTyping",
    "params":
     {
        "contactId":"user1@example.com",
        "chatId":"dbc2e7b6-25e8-450e-9670-c9e4f32341bb"
     },
    "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":"StopTyping",
     "state":"PROCESSING"
    }
  },
 "jsonrpc":"2.0",
 "background":false
}
If there are no errors, BEMS sends the following notification to the BlackBerry Connect app and the user stops typing the message. 
{
 "id": "c12",
 "sequence":1018698900000066,
 "result": 
  {
   "data": 
    {
     "method":"StopTyping",
     "state":"PROCESSING"
    }
  },
 "jsonrpc":"2.0",
}