Depth Property

The depth associated with the current operation.

Syntax

 caldav.getDepth([callback])
 caldav.setDepth( depth, [callback])

Possible Values

  0 (dpUnspecified), 
  1 (dpResourceOnly), 
  2 (dpImmediateChildren), 
  3 (dpInfinity)

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 getDepth([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 setDepth([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

This property defines how deep to operate within a collection. When performing certain operations on resource collections, the class will use Depth to instruct the server on how deep to operate within the collection. Depth is an enumerated type with the following possible values:


dpUnspecified (0)	The server will use the protocol default depth for the operation (this is normally "infinity").
dpResourceOnly (1)	The server will operate only on the collection resource URI, and not on any of its internal member resources.
dpImmediateChildren (2)	The server will operate on the collection resource URI and all of its immediate member resources (but on none of their member resources).
dpInfinity (3)	The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the collection hierarchy.

Depth is used when performing the following operations: LockCalendar, MoveCalendarEvent, CopyCalendarEvent, and GetCalendarReport

Data Type

Integer