3.8.1.11. Status | iCalendar (RFC 5545)

Try out our new RRULE tool for creating RRULE compatible strings.

f Share

URL

Property Name

STATUS

Purpose

This property defines the overall status or confirmation for the calendar component.

Value Type

TEXT

Property Parameters

IANA and non-standard property parameters can be specified on this property.

Conformance

This property can be specified once in "VEVENT", "VTODO", or "VJOURNAL" calendar components.

Description

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" calendar component, the "Organizer" can indicate that a meeting is tentative, confirmed, or cancelled. In a "VTODO" calendar component, the "Organizer" can indicate that an action item needs action, is completed, is in process or being worked on, or has been cancelled. In a "VJOURNAL" calendar component, the "Organizer" can indicate that a journal entry is draft, final, or has been cancelled or removed.

Format Definition

This property is defined by the following notation:

 status          = "STATUS" statparam ":" statvalue CRLF

 statparam       = *(";" other-param)

 statvalue       = (statvalue-event
                 /  statvalue-todo
                 /  statvalue-jour)

 statvalue-event = "TENTATIVE"    ;Indicates event is tentative.
                 / "CONFIRMED"    ;Indicates event is definite.
                 / "CANCELLED"    ;Indicates event was cancelled.
 ;Status values for a "VEVENT"

 statvalue-todo  = "NEEDS-ACTION" ;Indicates to-do needs action.
                 / "COMPLETED"    ;Indicates to-do completed.
                 / "IN-PROCESS"   ;Indicates to-do in process of.
                 / "CANCELLED"    ;Indicates to-do was cancelled.
 ;Status values for "VTODO".

 statvalue-jour  = "DRAFT"        ;Indicates journal is draft.
                 / "FINAL"        ;Indicates journal is final.
                 / "CANCELLED"    ;Indicates journal is removed.
;Status values for "VJOURNAL".

Example

The following is an example of this property for a "VEVENT" calendar component:

 STATUS:TENTATIVE

The following is an example of this property for a "VTODO" calendar component:

 STATUS:NEEDS-ACTION

The following is an example of this property for a "VJOURNAL" calendar component:

 STATUS:DRAFT

This document was automatically converted to XHTML using an RFC to HTML converter with the original text document at the Internet Engineering Task Force web site at ietf.org . The original text document should be referred to if there are any errors or discrepancies found in this document.

Need to test your iCalendar feeds? The iCalendar Validator provides developers and testers a method to validate their iCalendar feeds, which can take data from either a URL, file or text snippet and compare it against the RFC 5545 specification. We believe we have one of the best iCalendar validation tools available on the internet. More information about the validator can be found here.