ShareResource Method

Shares the specified file or folder.

Syntax

public String shareResource();

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 fieldsof SharedResourceInfo are applicable when calling this method:

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

DownloadURL (applicable to paid accounts only)
PasswordRequired
URL

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