CreateLinkOptionsMaxDownloads Property

The maximum downloads for a link.

Syntax

 sharefile.getCreateLinkOptionsMaxDownloads([callback])
 sharefile.setCreateLinkOptionsMaxDownloads( createLinkOptionsMaxDownloads, [callback])

Default Value

-1

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 getCreateLinkOptionsMaxDownloads([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 setCreateLinkOptionsMaxDownloads([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

The maximum downloads for a link.

The property specifies the number of downloads for a link. "-1" indicates an unlimited number of downloads. The field is always "-1" if the type is request. To modify this property see UpdateLink.

This property is not available at design time.

Data Type

Integer