CreateLink Method

Creates a new link for specified items.

Syntax

sharefile.createLink(itemIds, [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 will create a new link. The method will then fire the LinkList event, and will populate the Link* properties (clearing any previously-held items in the process) with the new link. ItemIds should be specified as a comma-separated list of one or more item Ids. The CreateLinkOptions* properties can be used to specify the different options for the newly created link.

Note that the string root may be used as a ItemIds to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

// Creates a folder, places two files into the folder, and creates a link to download the two files. 
string ParentId = shareFile.CreateFolder(name, "home");

shareFile.LocalFile = "./test.txt";
string id1 = shareFile.UploadFile("test.txt", ParentId);

shareFile.LocalFile = "./test_data.zip";
string id2 = shareFile.UploadFile("test_data.zip", ParentId);

string link = shareFile.CreateLink(id1 + "," + id2);