SharedResourceAccess Property

This property specifies the type of access granted to a shared link.

Syntax

 box.getSharedResourceAccess([callback])
 box.setSharedResourceAccess( sharedResourceAccess, [callback])

Possible Values

  0 (saDefault), 
  1 (saOpen), 
  2 (saCompany), 
  3 (saCollaborators)

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 getSharedResourceAccess([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 setSharedResourceAccess([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

This property specifies the type of access granted to a shared link. The possible values are:


0 (saDefault - default)	The default sharing settings for the account.
1 (saOpen)	Authorized users may access the link.
2 (saCompany)	Users within the same company may access the link.
3 (saCollaborators)	Only collaborators may access the link.

This property is not available at design time.

Data Type

Integer