LockTokens Property

The lock string to be used when submitting operations on a locked resource.

Syntax

 webdav.getLockTokens([callback])
 webdav.setLockTokens( lockTokens, [callback])

Default Value

""

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 getLockTokens([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 setLockTokens([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, LockTokens may be set to the tokens returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in LockTimeout. If the lock request is not a lock refresh, LockTokens must be empty, and will be parsed out of the server response after a successful call to the LockResource method.

Data Type

String

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