GetPreviewLink Method

Gets a link that may be used to preview the resource.

Syntax

box.getPreviewLink([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, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method gets a link that may be used to preview a resource. The link is designed to be embedded in in a web page (such as within an iframe).

Before calling this method set ResourceId to the file for which the link should be obtained. This method will return the preview link.