IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

LinkAccessLevel Property

The access level for the link.

Syntax

 sharefile.getLinkAccessLevel(index, [callback])
 sharefile.setLinkAccessLevel(index,  linkAccessLevel, [callback])

Possible Values

  0 (sflalAnonymous), 
  1 (sflalUserInfo), 
  2 (sflalEmployeesAndClients), 
  3 (sflalEmployeesOnly)

Default Value

0

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 the getLinkAccessLevel([callback]) 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.

The callback for the setLinkAccessLevel([callback]) 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 access level for the link.

This property reflects the link's access level. Possible values are:

  • 0 (sflalAnonymous)
  • 1 (sflalUserInfo)*
  • 2 (sflalEmployeesAndClients)
  • 3 (sflalEmployeesOnly)
*Requires a user to provide a first name, last name, email, and company. To modify this property see UpdateLink.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is not available at design time.

Data Type

Integer

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