on_before_download_file Event
This event is fired when a download file request is received.
Syntax
class SFTPServerBeforeDownloadFileEventParams(object): @property def connection_id() -> int: ... @property def path() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class SFTPServer: @property def on_before_download_file() -> Callable[[SFTPServerBeforeDownloadFileEventParams], None]: ... @on_before_download_file.setter def on_before_download_file(event_hook: Callable[[SFTPServerBeforeDownloadFileEventParams], None]) -> None: ...
Remarks
This event is fired when a request to download file is received from the client. The ConnectionID parameter specifies in which session the request was received.
Choose Action as one of the following values:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |