LockType Property

The type of the current resource lock.

Syntax

 webdav.getLockType([callback])
 webdav.setLockType( lockType, [callback])

Default Value

"write"

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 getLockType([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 setLockType([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

Before a call to the LockResource method, LockType may be set to the type of lock being requested. Currently, the class only supports requesting locks of type "write", although the protocol defines an optional "read" lock. After a successful LockResource operation, the class will set the LockType property to the correct value returned in the server's response.

Data Type

String

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