on_start_transfer Event

Fired when a file transfer begins.

Syntax

class XMPPStartTransferEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def file_id() -> str: ...
  @property
  def user() -> str: ...
  @property
  def domain() -> str: ...
  @property
  def resource() -> str: ...
  @property
  def filename() -> str: ...
  @filename.setter
  def filename(value) -> None: ...
  @property
  def datetime() -> str: ...
  @property
  def size() -> int: ...
  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class XMPP:
@property
def on_start_transfer() -> Callable[[XMPPStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[XMPPStartTransferEventParams], None]) -> None: ...

Remarks

When a file is received, the XMPP component will parse the sender's Jabber ID into the User, Domain, and Resource fields. The FileId and Filename parameters identify the current transfer. Within this event you may override the Filename by setting the Filename parameter. At this time you may also set local_directory if it is not already set.

When a sending a file, the XMPP component will parse the receiver's Jabber ID into the User, Domain, and Resource fields.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.