SharedLinkVisibility Property

The visibility of the link.

Syntax

 dropbox.getSharedLinkVisibility(index, [callback])

Possible Values

  0 (lvPublic), 
  1 (lvTeamOnly), 
  2 (lvPassword), 
  3 (lvTeamAndPassword), 
  4 (lvSharedFolderOnly)

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 getSharedLinkVisibility([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 setSharedLinkVisibility([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 visibility of the link.

This property reflects the visibility of the link. Possible values are:


0 (lvPublic)	Anyone with the link can access the linked resource.
1 (lvTeamOnly)	Only members of the same team with the link can access the linked resource. (Only applicable to Dropbox Business.)
2 (lvPassword)	Anyone with the link and the link's password can access the linked resource.
3 (lvTeamAndPassword)	Only members of the same team with the link and the link's password can access the linked resource. (Only applicable to Dropbox Business.)
4 (lvSharedFolderOnly)	Only members (with the link) of the shared folder containing the linked resource can access it.

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

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

Data Type

Integer