METHOD_RenameGroup

This method sends a request to BEMS to rename a group in the user's contact list.

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

Parameter

Type

 Required

Description

groupId

String

 √

This parameter specifies the ID of the group to rename.

newGroupName

String

 √

This parameter specifies the new name of the group.

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 that is sent to the BlackBerry Connect app when a group is renamed.

Parameter

Type

Description

method

String

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

state String This parameter specifies the state of the request to BEMS (for example, Processing or Complete).
message String This parameter specifies the message that is sent to the BlackBerry Connect app.

Example code

The following example sends a request to BEMS to rename a group to "Team building - summer" in the user's BlackBerry Connect app contact list.

{
  "method":"RenameGroup",
  "params":
    {
      "groupId":"1",
      "newGroupName":"Team building-summer"
    },
  "id":"c14",
  "jsonrpc":"2.0"
}

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

{
  "id":"c14",
  "error":null,
  "result":
   {
    "data":
     {
      "method":"RenameGroup",
      "state":"PROCESSING"
     }
   },
  "jsonrpc":"2.0",
  "background":false
}
If there are no errors, BEMS sends the following notification to the BlackBerry Connect app and the group is renamed. 
{
 "id": "c14",
 "sequence": 1018694700000051,
 "result": 
  {
   "data": 
    {
      "message":"Group rename Team building finished.",
      "method":"RenameGroup",
      "state":"COMPLETE"
    }
  },
 "jsonrpc":"2.0"
}