DownloadType Property
The download type to use for file resources.
Syntax
public BoxDownloadTypes DownloadType { get; set; }
enum BoxDownloadTypes { bdtFileContent, bdtFileThumbnail }
Public Property DownloadType As BoxDownloadTypes
Enum BoxDownloadTypes bdtFileContent bdtFileThumbnail End Enum
Default Value
0
Remarks
This property controls what the component 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 component 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.