Back to product page

FileTransferStart callback method


Called when file transfer starts.

Syntax

  • Basic
object.FileTransferStart (Owner, Contact, File, Action)
The FileTransferStart(object,Owner,Contact,File,Action) syntax has these parts:
objectAn expression evaluating to an object of type IwodXMPPNotify
OwnerAn expression evaluating to an object of type wodXMPP
ContactXMPPContact object
FileXMPPFile object
ActionXMPPActionsEnum enumeration

Remarks

This method is called only if you implemented IwodXMPPNotify interface in your application, and wodXMPP.Notification property has received reference to instance of your implementation.

This notification method will be called when file is about to be transferred. It can be result of your SendFile call, or when remote side initiates file transfer. At this point you can change any File object's properties to tweak transfer the way you need it - such as specifying full path in Name property, change DataIP etc.

After this notification method is called, FileTransferProgress notification method will be called several times as file is transferred. At the end of file transfer FileTransferEnd notification method will be called.

When Contact argument is NULL (Nothing in VB) it means that wodXMPP does not know who is downloading the file. This is typically result of ServeFile method and someone downloading such file.

Platforms

Windows