GetPreview Method

This method download a preview of a resource.

Syntax

dropbox.getPreview([callback])

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 this 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 method may be used to download a preview of a resource specified by ResourcePath. If applicable to the specified resource, Dropbox will generate a resource in HTML format and return this. Previews are only available for certain file types (.doc, .docx, .docm, .ppt, .pps, .ppsx, .ppsm, .pptx, .pptm, .xls, .xlsx, .xlsm, .rtf).

Example:

dropbox.ResourcePath = "/My Files/budget.xlsx"
dropbox.LocalFile = "C:\\preview.html";
dropbox.GetPreview();