METHOD_PC_UpdateRoom
This method sends a request to
BEMS
to update the group discussion settings.At least one parameter must be included in this method. If a parameter is not included, then the value is not updated for the group discussion.
The following table describes the parameters that you can include in the METHOD_PC_UpdateRoom method.
Parameter | Type | Required | Description |
---|---|---|---|
roomId | String | √ | This parameter specifies the ID of the group discussion to update. |
newName | String | — | This parameter specifies the new name for the group discussion. The updated name can be a maximum of 256 alphanumeric, numeric, special characters or a combination of these. This includes spaces. |
newDescription | String | — | This parameter specifies the updated description of the group discussion. The updated name can be a maximum of 256 characters. This includes spaces. |
newPrivacy | String | — | This parameter specifies the updated security level of the group discussion. |
newCategory | String | — | This parameter specifies the new category that the group discussion should move under. |
newSkipInvitations | Boolean | — | This parameter specifies if an invitation is sent. By default, this parameter is set to False.
|
InnerError
The following lists the errors that might occur when updating a group discussion:
- Name of group discussion is used by another group discussion. Group discussion names must be unique.
Code example
The following example sends a request to
BEMS
to rename the Surprise retirement celebration discussion group to Surprise retirement. { "method":"pc.UpdateRoom", "params": { "roomId":"ma-chan://gems.sw.rim.net/25ac15e7-9bff-4e78-9261-6e08aa43231e", "newName":Surprise retirement" }, "id":"c5", "jsonrpc":"2.0" }
If the request is successful,
BEMS
sends the following response to the BlackBerry Connect
app and processes the request.{ "id":"c5", "error":null, "result": { "data": { "method":"pc.UpdateRoom", "state":"PROCESSING" } }, "jsonrpc":"2.0", "state":"PROCESSING" }
If no error messages are returned,
BEMS
sends the following notification to the BlackBerry Connect
app and renames the group discussion.{ "id":"c5", "sequence":1018697900000013, "result": { "data": { "method":"pc.UpdateRoom", "state":"COMPLETE" } } "jsonrpc":"2.0" }