on_start_transfer Event
Fired when a file starts downloading/uploading.
Syntax
class SCPStartTransferEventParams(object): @property def direction() -> int: ... @property def local_file() -> str: ... @property def remote_file() -> str: ... @property def remote_path() -> str: ... @property def file_permissions() -> str: ... @file_permissions.setter def file_permissions(value) -> None: ... # In class SCP: @property def on_start_transfer() -> Callable[[SCPStartTransferEventParams], None]: ... @on_start_transfer.setter def on_start_transfer(event_hook: Callable[[SCPStartTransferEventParams], None]) -> None: ...
Remarks
The on_start_transfer event fires when the file starts transferring.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The LocalFile, RemoteFile, and RemotePath parameters provide information about the current transfer.
The FilePermissions parameter may be used to set the remote file permissions on file currently being uploaded. It will also be populated with the current permissions of the remote file when downloading. See file_permissions for more details.