SharedResourceVisibility Property

The visibility of the shared resource.

Syntax

 dropbox.getSharedResourceVisibility(index, [callback])

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 getSharedResourceVisibility([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 setSharedResourceVisibility([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 shared resource. This indicates who has access to use the SharedResourceLink to access the resource. Possible values are:


"public"	Anyone who has the link can access the resource. This is most common.
"team_only"	Only members of the same team can access the resource.
"password"	A link-specific password is required to access the resource.
"team_and_password"	Only members of the same team who also have a link-specific password can access the resource.
"shared_folder_only"	Only members of the shared folder can access the resource.

The size of the array is controlled by the SharedResourceCount property.

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

Data Type

String