DownloadType Property
The download type to use for file resources.
Syntax
box.getDownloadType([callback]) box.setDownloadType( downloadType, [callback])
Possible Values
0 (bdtFileContent), 1 (bdtFileThumbnail)
Default Value
0
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getDownloadType([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setDownloadType([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property controls what the class will download when DownloadFile is called for a file resource. Possible values are:
0 (bdtFileContent - default) | DownloadFile will download the file's contents. |
1 (bdtFileThumbnail) | DownloadFile will download a thumbnail of the file. |
File thumbnails may be customized using the ThumbnailFormat and ThumbnailSize configuration settings. Box returns placeholder thumbnail graphics for file types it cannot generate real thumbnails for.
If Box is still in the process of generating the requested thumbnail when this method is called, the class will populate the RetryAfter configuration setting and throw an exception. Retry the request after the number of seconds indicated by RetryAfter.
This property is not available at design time.
Data Type
Integer