SharedResourceCanPreview Property

Whether the resource can be previewed.

Syntax

 box.getSharedResourceCanPreview([callback])
 box.setSharedResourceCanPreview( sharedResourceCanPreview, [callback])

Default Value

FALSE

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 getSharedResourceCanPreview([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 setSharedResourceCanPreview([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

Whether the resource can be previewed. If True the resource can be previewed using the link. This is only applicable if SharedResourceAccess is set to saOpen or saCompany. The default value is False.

Data Type

Boolean