Library_Item_Downloadsession_File_Info

Library_Item_Downloadsession_File_Info
Library_Item_Downloadsession_File_Info

The File.Info structure defines the downloaded file.

JSON Example 
{
    "name": "string",
    "size": 0,
    "bytes_transferred": 0,
    "status": "string",
    "download_endpoint": {
        "uri": "string",
        "ssl_certificate_thumbprint": "string"
    },
    "checksum_info": {
        "algorithm": "string",
        "checksum": "string"
    },
    "error_message": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": {
                    "id": "string",
                    "params": {
                        "params": "Std_LocalizationParam Object"
                    }
                },
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    }
}
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.

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.

Library_Item_Downloadsession_File_PrepareStatus
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.

Library_Item_TransferEndpoint
download_endpoint
Optional

The TransferEndpoint structure encapsulates a URI along with extra information about it.

Library_Item_File_ChecksumInfo
checksum_info
Optional

Provides checksums for a File.Info object.

Std_LocalizableMessage
error_message
Optional

The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.

Returned By