Priority Property

Defines the relative priority for a calendar event.

Syntax

 caldav.getPriority([callback])
 caldav.setPriority( priority, [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 getPriority([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 setPriority([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 the relative priority of a calendar event. The priority is specified as an integer in the range 0 to 9. A value of 0 specifies an undefined Priority. A value of 1 is the highest Priority. A value of 2 is the second highest Priority. Subsequent numbers specify a decreasing ordinal Priority. A value of 9 is the lowest Priority.

A Calendar User-Agent (CUA) with a three-level Priority scheme of "HIGH", "MEDIUM", and "LOW" is mapped into this property such that a property value in the range of 1 to 4 specifies "HIGH" Priority. A value of 5 is the normal or "MEDIUM" Priority. A value in the range of 6 to 9 is "LOW" Priority.

This property is filled from the response to a GetCalendarEvent, and is also used when creating an event to be added using the PutCalendarEvent method. However, when requesting a report using the GetCalendarReport method, the contents of this property will only be valid inside the EventDetails event.

Data Type

Integer