StartTransfer Event

Fired when a file starts downloading/uploading.

Syntax

sftp.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.localFile
e.remoteFile

Remarks

The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring and/or a directory listing is started.

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

LocalFile identifies the local file. RemoteFile is the remote file.