Status Property

Defines the overall status or confirmation for the calendar event.

Syntax

 caldav.getStatus([callback])
 caldav.setStatus( status, [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 getStatus([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 setStatus([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

In a group-scheduled calendar component, the property is used by the Organizer to provide a confirmation of the event to the Attendees. For example in a vEvent EventType the Organizer can indicate that a meeting is tentative, confirmed, or canceled. For a vTodo EventType, the Organizer can indicate that an action item needs action, is completed, is in process or being worked on, or has been canceled. In a vJournal EventType, the Organizer can indicate that a journal entry is draft, final, or has been canceled or removed.

Statuses for a vEvent EventType:

TENTATIVEIndicates event is tentative.
CONFIRMEDIndicates event is definite.
CANCELLEDIndicates event was canceled.

Statuses for a vTodo EventType:

NEEDS-ACTIONIndicates to-do needs action.
COMPLETEDIndicates to-do completed.
IN-PROCESSIndicates to-do in process of.
CANCELLEDIndicates to-do was canceled.

Statuses for a vJournal EventType:

DRAFTIndicates event is draft.
FINALIndicates event is final.
CANCELLEDIndicates event is removed.

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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Node.js Edition - Version 20.0 [Build 8307]