on_before_rename_file Event
This event is fired when a client requests to rename a file.
Syntax
class SFTPServerBeforeRenameFileEventParams(object): @property def connection_id() -> int: ... @property def old_path() -> str: ... @property def new_path() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class SFTPServer: @property def on_before_rename_file() -> Callable[[SFTPServerBeforeRenameFileEventParams], None]: ... @on_before_rename_file.setter def on_before_rename_file(event_hook: Callable[[SFTPServerBeforeRenameFileEventParams], None]) -> None: ...
Remarks
This event is fired when a request to rename a file (from OldPath to NewPath) 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 |