Developer Documentation


The File.Info structure defines the downloaded file.


Required Property Name Type Description
required bytes_transferred integer

The number of bytes that have been transferred by the server so far for making this file prepared for download. This value may stay at zero till the client starts downloading the file.

optional checksum_info FileChecksumInfo

The checksum information of the file. When the download is complete, you can retrieve the checksum from the File.get operation to verify the checksum for the downloaded file. The checksum is always calculated for the downloaded file, but this field won’t be set until the download is complete.

optional download_endpoint ItemTransferEndpoint

Endpoint at which the file is available for download. The value is valid only when the File.Info.status is PREPARED. This field won’t be set until the file status is PREPARED.

optional error_message StdLocalizableMessage

Error message for a failed preparation when the prepare status is ERROR. This field won’t be set unless there was an error with the file transfer.

required name string

The name of the file.

optional size integer

The file size, in bytes. This field may not be available immediately. It is guaranteed to be set when the client finishes downloading the file.

required status FilePrepareStatus Enum

The preparation status (PrepareStatus) of the file.


Was this page helpful?