SecureBlackbox Lite 2020 Python Edition

Questions / Feedback?

on_progress Event

Fires periodically during the data transfer.

Syntax

class SFTPClientProgressEventParams(object):
  @property
  def total() -> int: ...
  @property
  def current() -> int: ...
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class SFTPClient:
@property
def on_progress() -> Callable[[SFTPClientProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[SFTPClientProgressEventParams], None]) -> None: ...

Remarks

Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.

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