on_start_transfer Event

Fired when a file starts downloading/uploading.

Syntax

class SFTPStartTransferEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def local_file() -> str: ...
  @property
  def remote_file() -> str: ...

# In class SFTP:
@property
def on_start_transfer() -> Callable[[SFTPStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[SFTPStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer 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.