SecureBlackbox 2020 Python Edition

Questions / Feedback?

on_file_operation Event

Marks the start of a file transfer.

Syntax

class FTPClientFileOperationEventParams(object):
  @property
  def operation() -> int: ...
  @property
  def remote_path() -> str: ...
  @property
  def local_path() -> str: ...
  @property
  def skip() -> bool: ...
  @skip.setter
  def skip(value) -> None: ...
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class FTPClient:
@property
def on_file_operation() -> Callable[[FTPClientFileOperationEventParams], None]: ...
@on_file_operation.setter
def on_file_operation(event_hook: Callable[[FTPClientFileOperationEventParams], None]) -> None: ...

Remarks

The class fires this event from download_files and upload_files to notify the application that the transfer of the next file in the list is about to start.

Use the Skip parameter to skip this particular file, or Cancel to cancel the whole multi-file operation.

Operations:

cffoDownloadFile0Download file

cffoUploadFile1Upload file

cffoDeleteFile2Delete file

cffoMakeDir3Make directory

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