Organizer Property

Defines the organizer of a calendar event.

Syntax

 caldav.getOrganizer([callback])
 caldav.setOrganizer( organizer, [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 getOrganizer([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 setOrganizer([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 is specified within the vEvent, vTodo, and vJournal calendar EventTypes to specify the organizer of a group-scheduled calendar entity. The property is specified within the vFreeBusy EventType to identify the calendar user requesting the free or busy time. When publishing a vFreeBusy EventType, the property is used to specify the calendar that the published busy time came from.

Each email address should be in the mailto URI format (as defined in RFC2368).

For instance:

  CalDAV.Organizer = "mailto:jane_doe@example.com";

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

String