METHOD_PC_GetRoom

This method retrieves the group discussion details.

Parameter	Type	Required	Description
roomId	String	√	This parameter specifies the ID of the group discussion.

Notification

The following table describes the notifications that

BEMS

might send to the

BlackBerry Connect

app after it processes the request.

Parameter

Type

Description

id

String

This parameter specifies the group discussion ID.

name

String

This parameter specifies the group discussion name.

description

String

This parameter specifies the description of the group discussion.

category

String

This parameter specifies the category ID of the group discussion it is placed under.

privacy

String

This parameter specifies the security level of the group discussion.

isMemberOf

Boolean

This parameter specifies if the user is a member of the group discussion.

isManagerOf

Boolean

This parameter specifies if the user is a manager of the group discussion.

isDisabled

Boolean

This parameter specifies if the group discussion is disabled.

skipInvitations

Boolean

This parameter specifies if an invitation should not be sent. By default, this parameter is set to False.

If true, an invitation is sent.

If false, the invitation is not sent, but inherited from the category parameter.

managers

Principal Array

This parameter specifies an Array of Principals. Each array includes the following parameters:

Parameter	Type	Description
name	String	This parameter specifies the name of the user or group.
id	String	This parameter specifies the ID of the user or group.
type	String	This parameter specifies the manager or member as one of the following: user group
displayName	String	This parameter specifies the display name of the user or group.

members

Principal Array

Code example

The following example sends a request to

BEMS

to retrieve the group discussion details.

{
  "method":"pc.GetRoom",
  "params":
    {
     "roomId":"ma-chan://gems.sw.rim.net/25ac15e7-9bff-4e78-9261-6e08aa43231e"
    },
  "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.GetRoom",
      "state":"PROCESSING"
    }
   },
  "jsonrpc":"2.0",
  "background":false
}

If no error messages are returned,

BEMS

sends the following notification to the

BlackBerry Connect

app and displays the group discussion details.

{
  "id":"c5",
  "sequence":1018695900000011,
  "result":
   {
    "data":
    {
     "id":"ma-chan://gems.sw.rim.net/25ac15e7-9bff-4e78-9261-6e08aa43231e", 
     "name":"Surprise retirement celebration", 
     "category":"ma-cat://gems.sw.rim.net/9d58ae36-7490-47d4-8a55-56b2d21ae6e3",
     "description":"Discuss potluck options", 
     "privacy":"Secret", 
     "isMemberOf":true,
     "isManagerOf":true, 
     "skipInvitations":false, 
     "isDisabled":false,
     "managers":
      [ 
        { 
          "id":"sip:user1@example.com", 
          "name":"User1", 
          "type":"user", 
          "displayName":"User 1"
        },
        { 
          "id":"ma-grp://gem.sw.rim.net/52cb55f8-5fee-3a78-9271-7d18bb6323cc", 
          "name":"DesertMenuGroup", 
          "type":"group", 
          "displayName":"Desert Menu Group"
         }
      ],
     "members":
      [ 
        { 
          "id":"sip:user1@example.com", 
          "name":"User1", 
          "type":"user", 
          "displayName":"User 1"
        },
        { 
          "id":"sip:user2@example.com", 
          "name":"User2", 
          "type":"user", 
          "displayName":"User 2"
        }
      ]
    "skipInvitations":false,
    "isDisabled":true,
    "method":"pc.GetRoom",
    "state":"COMPLETE"
   }
  },
 "jsonrpc":"2.0"
}