StartTransfer Event

Fired when a file transfer begins.

Syntax

xmpp.on('StartTransfer', [callback])

Callback

The 'callback' is called when the 'StartTransfer' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.direction
e.fileId
e.user
e.domain
e.resource
e.filename
e.datetime
e.size
e.accept

Remarks

When a file is received, the XMPP component will parse the sender's Jabber ID into the User, Domain, and Resource fields. The FileId and Filename parameters identify the current transfer. Within this event you may override the Filename by setting the Filename parameter. At this time you may also set LocalDirectory if it is not already set.

When a sending a file, the XMPP component will parse the receiver's Jabber ID into the User, Domain, and Resource fields.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.