FileTransferResponse Properties

The FileTransferResponse type exposes the following members.

Properties

	Name	Description
	File	For file transfers initiated at the destination (FileTransferDirection.Pull), contains information about the file to be transferred. For file transfers initiated by the source (FileTransferDirection.Push), this property should be NULL. For FileTransferMode.InBand, this structure will contain the file payload (data) itself. For FileTransferMode.OutOfBand, this structure will contain a secure link/URL that can be used by the destination to obtain the file payload data.
	FileLocation	An optional property that may be used to indicate the location to the file on the source system. This need not be a physical path. It could be as virtual path, as in the case of a web or FTP server, or file share. Alternatively, it need not represent a traditional path at all. For example, it could be a lookup key to locate the file within a NoSQL database environment. The format of this property is dependent on the nature of the source system.
	FileTitle	The title of the file, EXCLUDING any path information, but INCLUDING file extension when appropriate.
	Result	Result of the request
	TransferMode	Specifies the mode of transfer. File data may be transferred within the CFX messages themselves (In-Band), or transferred via a separate secure protocol (Out-of-Band), such as HTTPS, SFTP, etc. Direct, in-band file transfer is not recommended for larger data files. Many AMQP message broker platforms limit the maximum total message size of an AMQP message. Microsoft's Azure message bus, for example, limits messages to 256KB for a standard subscription, and 1MB for a premium subscription. RabbitMQ recommends limiting messages to 128MB or less. Use OutOfBand transfer for larger file sizes.

Top

See Also