UnshareResource Method

Stops sharing a resource.

Syntax

box.unshareResource([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 unshares a resource so it is no longer shared. Before calling this method set ResourceId to the resource for which you wish to stop sharing.

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();