IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

UpdateLink Method

Updates a request or download link.

Syntax

sharefile.updateLink(linkId, [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 updates the link information for a link identified by LinkId. The the class requires the link to be in the Link* properties and be modified from there.

The following properties can be updated from the ShareFileLink* properties:

  • ExpirationDate
  • MaxDownloads
  • Name
  • RequireLogin
  • Title


// Updates a link to require login.
shareFile.Links[1].RequireLogin = true;
shareFile.UpdateLink(shareFile.Links[1].Id);

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Node.js Edition - Version 20.0 [Build 8265]