IPWorks EDI 2020 Node.js Edition

Questions / Feedback?

Transfer Event

Fired while a document transfers (delivers document).

Syntax

oftpclient.on('Transfer', [callback])

Callback

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

function(e){ }

The argument 'e' has the following properties:

e.direction
e.localFile
e.virtualFileName
e.virtualFileDate
e.destination
e.originator
e.bytesTransferred
e.text (buffer)

Remarks

The Text parameter contains the portion of the document text being retrieved. It is empty if data is being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text.

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

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 Node.js Edition - Version 20.0 [Build 8203]