IPWorks MQ 2020 JavaScript Edition

Questions / Feedback?

Transfer Event

Fired during file transfer.

Syntax

xmpp.on('Transfer', listener: (e: {readonly direction: number, readonly fileId: string, readonly filename: string, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array, cancel: boolean}) => void )

Remarks

This event will fire when sending or receiving. One or more Transfer events are fired during file transfer.

The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

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

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

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

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks MQ 2020 JavaScript Edition - Version 20.0 [Build 8262]