METHOD_PC_MuteRooms

This method mutes or unmutes a group discussion that the user is a member of or following. When the user mutes a group discussion, all notifications related to the group discussion are suppressed. The BEMS-Connect service maintains a list of muted group discussions per session and this method can be used to add or remove muted group discussions from the list or replace the list with a new list.

Note: The METHOD_PC_MuteRooms does not validate the groups discussion IDs. Muting a group discussion is per session and not persistent in the Connect service. Each time BlackBerry Connect establishes a new session, the list is re-sent to the BlackBerry Connect app.

Parameter

Type

Required

Description

roomsToMute

String Array

—*

This parameter specifies a list of group discussion IDs that users can mute.

roomsToUnmute

String Array

—*

This parameter specifies a list of group discussion IDs that users can unmute and receive notifications for.

replaceList

Boolean

√

This parameter specifies one of the following actions:

  • If true, the list of group discussions in the BEMS-Connect service is replaced with the passed in list.
  • If false, the BEMS-Connect service adds or removes group discussions from the list of group discussions the user is following.

* If replaceList is true, then the roomsToFollow is required and roomsToUnfollow should no be passed in. If replaceList is false, either roomsToFollow or roomsToUnfollow must be passed in.

Code example

The following example sends a request to BEMS to mute two group discussions and unmute one group discussion.

{
  "method":"pc.MuteRooms",
  "params":
    {
      roomsToMute: [
        "ma-chan://gems.example.com/25ac15e7-9bff-4e78-9261-6e08aa43231e",
        "ma-chan://gems.example.com/d19de8b1-469c-4a92-a8c0-f5e37ba62db6"
        ],
      roomsToUnmute: [
        "ma-chan://gems.example.com/f7972fdb-7ea9-4d7f-be4c-d27c8d9c44bc"
        ],
      replaceList:true
    },
  "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.MuteRooms",
          "state":"PROCESSING"
        }
    },
   "jsonrpc":"2.0",
   "background":false
}

If there are no errors, BEMS sends the following notification to the BlackBerry Connect app and mutes and unmutes the specified group discussions.

{
    "id":"c5",
    "error":null,
    "result":
    {
      "data":
        {
          "method":"pc.MuteRooms",
          "state":"COMPLETE"
        }
    },
    "jsonrpc":"2.0"
}