Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

SharedResourcePasswordRequired Property

Whether the link is protected by a password.

Syntax

 box.getSharedResourcePasswordRequired([callback])

Default Value

FALSE


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 getSharedResourcePasswordRequired([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 setSharedResourcePasswordRequired([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

Whether the link is protected by a password. If True a password must be provided to access the resource at the link.

This property is read-only.

Data Type

Boolean

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0