METHOD_SetPersonalMessage
This method sets the personal message for the user. Microsoft refers to this method as 'status'.
The following table describes the parameters that you can include in this method.
|
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
personalMessage |
String |
√ |
This parameter specifies the user's personal message (for example, I am in a meeting). |
| 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 sets a personal message.
|
Parameter |
Type |
Description |
|---|---|---|
|
method |
String |
This parameter specifies the invoked method (for example, SetPersonalMessage). |
| state | String | This parameter specifies the state of the request to BEMS (for example, Processing or Complete). |
Code example
The following example sends a request to BEMS to set the user's personal message.
{
"id":"c12",
"method":"SetPersonalMessage",
"params":
{
"personalMessage":"I am in a meeting"
},
"jsonrpc":"2.0"
}
If the request is successful, BEMS returns the following response to the BlackBerry Connect app and processes the request.
{
"id":"c12",
"error":null,
"result":
{
"data":,
{
"method":"SetPersonalMessage",
"state":"PROCESSING"
}
},
"jsonrpc":"2.0"
"background":false
}
If there are no errors, BEMS sends the following notification to the BlackBerry Connect app and sets the personal message.
{
"id":"c12",
"sequence":1018697800000053,
"result":
{
"data":
{
"method":"SetPersonalMessage",
"state":"COMPLETE"
}
},
"jsonrpc":"2.0"
}