SecureBlackbox 2020 Python Edition

Questions / Feedback?

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:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Python Edition - Version 20.0 [Build 8154]