PermissionNotifyOnDownload Property

If the user is notified when the an item is downloaded from the folder.

Syntax

 sharefile.getPermissionNotifyOnDownload(index, [callback])
 sharefile.setPermissionNotifyOnDownload(index,  permissionNotifyOnDownload, [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 getPermissionNotifyOnDownload([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 setPermissionNotifyOnDownload([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 is notified when the an item is downloaded from the folder.

This property specifies if the user will be notified if an item is downloaded from the folder. 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