LockScope Property

The scope of the current resource lock.

Syntax

 caldav.getLockScope([callback])
 caldav.setLockScope( lockScope, [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 getLockScope([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 setLockScope([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 scope of the current resource lock.

Before the calendar resource can be locked, the Lock LockScope may be set to the type of scope needed for the lock. Currently the class will only allow two types of scopes to be requested:


"exclusive"	The lock belongs exclusively to the requesting principle. No other principle may modify the locked resource URI.
"shared"	The locked resource may not be modified by non-trusted principles. Users who have access rights, however, may request a shared lock which they can then use to modify or operate on the resource.

If no scope is specified, the protocol default scope, "exclusive", will be requested. After a successful LockCalendar operation, the class will set the LockScope property to the correct value returned in the server's response.

Data Type

String