ShareResource Method

Shares the specified file or folder.

Syntax

box.shareResource([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 shares the resource specified by ResourceId and returns a link that may be shared with other users.

Settings for the accessing the shared resource may optionally be provided by setting SharedResourceInfo before calling this method. The following properties are applicable when calling this method:

• SharedResourceAccess
• SharedResourceCanDownload
• SharedResourceCanPreview
• SharedResourcePassword
• SharedResourceUnsharedDate (paid accounts only)

After calling this method SharedResource* properties are populated with the details of the link. Additionally the link to share is returned by the method. The following read-only properties are populated:

• SharedResourceDownloadURL (applicable to paid accounts only)
• SharedResourcePasswordRequired
• SharedResourceURL

Resource Sharing Example:

box.ResourceId = "myResourceId";
box.SharedResourceInfo.Password = "password"; //optional
string sharedLink = box.ShareResource();

//The sharedLink may now be shared with other users.

//If a sharedLink is received from another user, obtain information about the resource.
//This must be called before attempting to download the resource
box.GetSharedResourceInfo(url, "password"); //pass empty string if no password is required.

//Download the file as normal once the resource info has been obtained.
box.LocalFile = "..\\myFile.txt";
box.DownloadFile();

//To stop sharing a resource call UnshareResource
box.ResourceId = "myResourceId";
box.UnshareResource();