on_upload_file Event

An override for a file upload initiation operation.

Syntax

class FTPServerUploadFileEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def path() -> str: ...
  @property
  def restart_at() -> int: ...
  @property
  def append() -> bool: ...
  @property
  def operation_status() -> int: ...
  @operation_status.setter
  def operation_status(value) -> None: ...

# In class FTPServer:
@property
def on_upload_file() -> Callable[[FTPServerUploadFileEventParams], None]: ...
@on_upload_file.setter
def on_upload_file(event_hook: Callable[[FTPServerUploadFileEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application perform an overridden file upload initiation operation.

This event only fires if Action = fraCustom was passed back from on_before_upload_file event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by a number of on_write_file calls, passing the file data to your code, followed by a single on_transfer_completed call.

Set OperationStatus to one of the following values: