on_start_transfer Event
Fired when a document starts transferring.
Syntax
class OFTPServerStartTransferEventParams(object): @property def connection_id() -> int: ... @property def direction() -> int: ... @property def local_file() -> str: ... @local_file.setter def local_file(value) -> None: ... @property def virtual_file_name() -> str: ... @property def virtual_file_date() -> str: ... @property def destination() -> str: ... @property def originator() -> str: ... # In class OFTPServer: @property def on_start_transfer() -> Callable[[OFTPServerStartTransferEventParams], None]: ... @on_start_transfer.setter def on_start_transfer(event_hook: Callable[[OFTPServerStartTransferEventParams], None]) -> None: ...
Remarks
This event fires when a file transfer begins.
Direction specifies if the client or server sent the file.
| 0 (Client) | The file originated from the client. |
| 1 (Server) | The file originated from the server. |
VirtualFileName holds the filename.
VirtualFileDate holds the date associated with the file in the format "MM/dd/yyyy HH:mm:ss".
Originator identifies the sender (SFID) code in the send file request.
Destination identifies the receiver (SFID) code in the send file request.
LocalFile holds the full path to the file that will be written.
ConnectionId identifies the connected client.