DownloadType Property

The download type to use for file resources.

Syntax

int GetDownloadType();
int SetDownloadType(int iDownloadType);

Possible Values

BDT_FILE_CONTENT(0), 
BDT_FILE_THUMBNAIL(1)

Default Value

0

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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Qt Edition - Version 20.0 [Build 8265]