ResourceSharedLinkAccess Property

Access level afforded by the resource's shared link.

Syntax

 box.getResourceSharedLinkAccess(index, [callback])

Possible Values

  0 (slaOpen), 
  1 (slaCompany), 
  2 (slaCollaborators)

Default Value

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 getResourceSharedLinkAccess([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 setResourceSharedLinkAccess([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

Access level afforded by the resource's shared link.

This property reflects the access level that the resource's ResourceSharedLink provides. Possible values are:


0 (slaOpen - default)	Anyone can access the resource using the link.
1 (slaCompany)	Only members of the company can access the resource using the link.
2 (slaCollaborators)	Only members of the folder the resource is in can access the resource using the link.

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

This property is read-only and not available at design time.

Data Type

Integer