on_before_rename_file Event
Notifies about an incoming file rename request.
Syntax
class FTPServerBeforeRenameFileEventParams(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 FTPServer: @property def on_before_rename_file() -> Callable[[FTPServerBeforeRenameFileEventParams], None]: ... @on_before_rename_file.setter def on_before_rename_file(event_hook: Callable[[FTPServerBeforeRenameFileEventParams], None]) -> None: ...
Remarks
The class fires this event to notify the application about a received file rename request. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to on_rename_file to be notified when to perform the request. It is the on_rename_file event handler where you should perform the overridden action.
Upon completion of the request, either in manual or override mode, the on_after_rename_file event will be fired.
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 |