Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry Enterprise Mobility Server 3.7
  3. BlackBerry Connect messaging APIs
  4. Instant messaging methods
  5. METHOD_DeclineFileXfer

METHOD_DeclineFileXfer

This method declines the file transfer invitation from the sender in a one-to-one chat.
The following table lists the parameters that you can include in this method. 
Parameter
Type
Required
Description
contactid
String
√
This parameter specifies the ID of the contact that sends the file.
fileId
String
√
This parameter specifies the file ID created by the
BlackBerry Connect
 client for the file.

BEMS
 response and notification

The following table describes the parameters that
BEMS
 returns and the notification sent to the
BlackBerry Connect
 app when the file is declined.
Parameter
Type
Description
chatId
String
This parameter returns the ID of the chat that the file transfer invite is sent to.
method
String
This parameter specifies the invoked method (for example, DeclineFileXfer).
state
String
This parameter specifies the state of the request to
BEMS
 (for example, Processing or Completed).

Code example

The following example sends a request to
BEMS
 to decline the file transfer from "user1" in the chat.
{
 "method":"DeclineFileXfer",
 "params":
  {
    "contactId":"sip:user1@example.com",
    "fileId":"dbc2e7b6-25e8-450e-9670-c9e4f32341bb"
  },
 "id":"c55",
 "jsonrpc":"2.0"
}
If the request is successful,
BEMS
 sends the following response to the
BlackBerry Connect
 app and processes the request.
{
  "id":"c55",
  "error": null,
  "result": 
     {
       "data": 
         {
          "method": "DeclineFileXfer",
          "state": "PROCESSING"
         }
     },
  "jsonrpc": "2.0"
}
If there are no errors,
BEMS
 sends the following notification to the
BlackBerry Connect
 app and declines the file. 
{
  "id":"c55",
  "error": null,
  "result": 
     {
       "data": 
         {
          "method": "DeclineFileXfer",
          "state": "COMPLETED"
         }
     },
  "jsonrpc": "2.0"
}