download_type Property
The download type to use for file resources.
Syntax
def get_download_type() -> int: ... def set_download_type(value: int) -> None: ...
download_type = property(get_download_type, set_download_type)
Default Value
0
Remarks
This property controls what the class will download when download_file is called for a file resource. Possible values are:
| 0 (bdtFileContent - default) | download_file will download the file's contents. |
| 1 (bdtFileThumbnail) | download_file 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.