CreateRequestLink Method
Creates a new request link.
Syntax
sharefile.createRequestLink(folderId, [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 request 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 request link. It will also return the new request link as a string. FolderId is the ID for the directory where the files will be uploaded in ShareFile. 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 FolderId 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
string FolderId = shareFile.CreateFolder("Incoming Folder", "home"); string Link = shareFile.CreateRequestLink(FolderId);