on_rename_file Event

This event is fired when a client requests to rename a file.

Syntax

class SFTPServerRenameFileEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def old_path() -> str: ...
  @property
  def new_path() -> str: ...
  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class SFTPServer:
@property
def on_rename_file() -> Callable[[SFTPServerRenameFileEventParams], None]: ...
@on_rename_file.setter
def on_rename_file(event_hook: Callable[[SFTPServerRenameFileEventParams], 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.

Set OperationStatus to one of the below values according to the outcome of the request processing: