LibraryItemDownloadsessionFileInfo

The File.Info structure defines the downloaded file.


Properties

integer as int64
bytes_transferred Required

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.


checksum_info Optional

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.


download_endpoint Optional

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.


error_message Optional

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.


string
name Required

The name of the file.


integer as int64
size Optional

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.


status Required

The File.PrepareStatus enumerated type defines the state of the file in preparation for download.
UNPREPARED : The file hasn’t been requested for preparation.
PREPARE_REQUESTED : A prepare has been requested, however the server hasn’t started the preparation yet.
PREPARING : A prepare has been requested and the file is in the process of being prepared.
PREPARED : Prepare succeeded. The file is ready for download.
ERROR : Prepare failed.

Possible values are: UNPREPAREDPREPARE_REQUESTEDPREPARINGPREPAREDERROR

JSON Example

{
	"bytes_transferred": 0,
	"name": "string",
	"status": "UNPREPARED"
}

Feedback

Was this page helpful?