GetSharedResourceInfo Method

Gets information about a shared resource.

Syntax

box.getSharedResourceInfo(sharedLink, password, [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 gets information about the shared resource specified by the SharedLink parameter.

This method must be called before downloading a shared resource.

SharedLink specifies the link that was provided by the user that shared the resource. This is required.

Password specifies the password required to access the link. If no password is required pass empty string for this parameter.

After calling this information details about the resource will be provided in the Resource* properties. In addition SharedResource* properties will also be populated with information about the shared link itself.

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