on_transfer Event

Fired while a document transfers (delivers document).

Syntax

class OFTPServerTransferEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def direction() -> int: ...
  @property
  def local_file() -> str: ...
  @property
  def virtual_file_name() -> str: ...
  @property
  def virtual_file_date() -> str: ...
  @property
  def destination() -> str: ...
  @property
  def originator() -> str: ...
  @property
  def bytes_transferred() -> int: ...
  @property
  def text() -> bytes: ...

# In class OFTPServer:
@property
def on_transfer() -> Callable[[OFTPServerTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[OFTPServerTransferEventParams], None]) -> None: ...

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.

ConnectionId identifies the connected client.