CreateLink Method

Creates a shared link for a resource.

Syntax

dropbox.createLink(resource, [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, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method creates a shared link for the resource specified by Resource and returns it.

Resource must be a path, an Id-based relative path, or a resource Id.

The CreateLinkExpiration, CreateLinkVisibility, and CreateLinkPassword configuration settings can be used to customize the settings used to create the shared link.

// Create a password-protected shared link for the given file.
dropbox.Config("CreateLinkPassword=password");
string sharingUrl = dropbox.CreateLink("/work_stuff/serious_business/best_cat_pictures.zip");