DownloadType Property

The download type to use for file resources.

Syntax

 dropbox.getDownloadType([callback])
 dropbox.setDownloadType( downloadType, [callback])

Possible Values

  0 (ddtFileContent), 
  1 (ddtFileThumbnail), 
  2 (ddtFilePreview)

Default Value

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 (ddtFileContent - default)	DownloadFile will download the file's contents.
1 (ddtFileThumbnail)	DownloadFile will download a thumbnail of the file.
2 (ddtFilePreview)	DownloadFile will download a PDF- or HTML-based preview of the file.

File thumbnails may be customized using the ThumbnailFormat, ThumbnailMode, and ThumbnailSize configuration settings; and are supported for the following file types: .bmp, .gif, .jpeg, .jpg, .png, .tif, and .tiff.

File previews are supported for the following file types:

PDF-based: .ai, .doc, .docm, .docx, .eps, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, and .rtf.
HTML-based: .csv, .ods, .xls, .xlsm, and .xlsx

This property is not available at design time.

Data Type

Integer