EVENT_FileXferInvitationReceived

This notification notifies the sender that the recipient in the one-to-one chat received the file transfer invitation. The recipient can accept or decline the file transfer.

The following table lists the parameters that you can include in this method.

Parameter

Type

Description

contactId

String

This parameter specifies the ID of the contact that sends the file.

fileName

String

This parameter specifies the name of the file to send.

fileSize

Long

This parameter specifies the size of the file to send.

fileId

String

This parameter specifies the file ID created by the BlackBerry Connect client for the file. This value is passed to the AcceptFileXfer method. For more information, see METHOD_AcceptFileXfer.

method

String

This parameter returns the invoked method (for example, FileXferInvitationReceived).

Code example

If the notification is successful, BEMS sends the following notification to the BlackBerry Connect app and includes the file name and size. In the following example, the recipient receives an invitation from "user1" to accept a file called "MyFile". 

{
  "id":"S38",
  "error":null,
  "result":
   {
    "data":
     {
      "contactId":"sip:user1@example.com",
      "fileName":"MyFile.txt",
      "fileSize":55550000,
      "fileId":"dbc2e7b6-25e8-450e-9670-c9e4f32341bb",
      "method":"FileXferInvitationReceived"
     }
   },
  "jsonrpc":"2.0"
}