LockTimeout Property

The time to live for the current resource lock.

Syntax

 webdav.getLockTimeout([callback])
 webdav.setLockTimeout( lockTimeout, [callback])

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 getLockTimeout([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 setLockTimeout([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, LockTimeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If Timeout of 0 is specified, the server will use a default timeout. After a successful LockResource operation, the class will set the LockTimeout property to the correct value returned in the server's response.

Data Type

Integer