LinkIsViewOnly Property

If the share items can only be viewed.

Syntax

 sharefile.getLinkIsViewOnly(index, [callback])
 sharefile.setLinkIsViewOnly(index,  linkIsViewOnly, [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 getLinkIsViewOnly([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 setLinkIsViewOnly([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

If the share items can only be viewed.

If true, the share items can only be viewed but not downloaded. Requires account preference EnableViewOnly to work. This feature can be enabled for Enterprise accounts by request.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is not available at design time.

Data Type

Boolean