PermissionCanDownload Property

If the user can read file content or download the item or from the item.

Syntax

 sharefile.getPermissionCanDownload(index, [callback])
 sharefile.setPermissionCanDownload(index,  permissionCanDownload, [callback])

Default Value

TRUE

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 getPermissionCanDownload([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 setPermissionCanDownload([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 user can read file content or download the item or from the item.

This property defines whether the user can download or read from the item. To modify this property see UpdatePermission.

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

This property is not available at design time.

Data Type

Boolean