IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

UpdatePermission Method

Updates the permission from the Permission* properties.

Syntax

sharefile.updatePermission(index, recursive, [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

The permission at Index in the Permission* properties will be updated.

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

  • CanDelete
  • CanDownload
  • CanManagePermissions
  • CanUpload
  • CanView
  • NotifyOnDownload
  • NotifyOnUpload

// Updates permission so that the user does not have permission to download from the folder.
shareFile.Permissions[1].CanDownload = false;
shareFile.UpdatePermission(1, true);

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