on_remove Event

This event is fired when a client requests to delete a file or directory.

Syntax

class SFTPServerRemoveEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def path() -> str: ...
  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class SFTPServer:
@property
def on_remove() -> Callable[[SFTPServerRemoveEventParams], None]: ...
@on_remove.setter
def on_remove(event_hook: Callable[[SFTPServerRemoveEventParams], None]) -> None: ...

Remarks

This event is fired when a request to delete a file or directory 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: