ListSharedResources Method

This method lists information about the shared resources.

Syntax

dropbox.listSharedResources(path, [callback])

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 this 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 method may be called to obtain information about shared resources specified by the Path parameter. Path should be set to an absolute path of a file or folder.

If the Path parameter is left empty information for all shared resources for the current user is returned.

When this method is called the SharedResourceList event fires for each shared resource. After calling this method the following properties are populated:

• SharedResourceLink
• SharedResourcePath
• SharedResourceVisibility
• SharedResourceExpires

Example:

//Share the resource. The returned URL can be used to access the shared resource
dropbox.ResourcePath = "/My Folder"
string URL = dropbox.ShareResource();

//Later to get the URL again we can check the resource to see if it's shared
dropbox.ListSharedResources(folder + "/test.zip");
URL = dropbox.SharedResources[0].Link;

//When we no longer want to share the resource we can unshare it.
dropbox.UnshareResource(URL);