--- 1/draft-ietf-calext-jscalendar-04.txt 2018-07-02 05:15:09.212263783 -0700 +++ 2/draft-ietf-calext-jscalendar-05.txt 2018-07-02 05:15:09.328266573 -0700 @@ -1,18 +1,18 @@ Calendaring extensions N. Jenkins Internet-Draft R. Stepanek Intended status: Standards Track FastMail -Expires: November 26, 2018 May 25, 2018 +Expires: January 3, 2019 July 2, 2018 JSCalendar: A JSON representation of calendar data - draft-ietf-calext-jscalendar-04 + draft-ietf-calext-jscalendar-05 Abstract This specification defines a data model and JSON representation of calendar data that can be used for storage and data exchange in a calendaring and scheduling environment. It aims to be an alternative to the widely deployed iCalendar data format and to be unambiguous, extendable and simple to process. Status of This Memo @@ -23,21 +23,21 @@ Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." - This Internet-Draft will expire on November 26, 2018. + This Internet-Draft will expire on January 3, 2019. Copyright Notice Copyright (c) 2018 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents @@ -57,102 +57,103 @@ 2.2. JSTask . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.3. JSGroup . . . . . . . . . . . . . . . . . . . . . . . . . 6 3. Structure of JSCalendar objects . . . . . . . . . . . . . . . 6 3.1. Type signatures . . . . . . . . . . . . . . . . . . . . . 6 3.2. Data Types . . . . . . . . . . . . . . . . . . . . . . . 7 3.2.1. UTCDate . . . . . . . . . . . . . . . . . . . . . . . 7 3.2.2. LocalDate . . . . . . . . . . . . . . . . . . . . . . 7 3.2.3. Duration . . . . . . . . . . . . . . . . . . . . . . 7 3.2.4. PatchObject . . . . . . . . . . . . . . . . . . . . . 8 3.2.5. Identifiers . . . . . . . . . . . . . . . . . . . . . 8 - 3.2.6. Normalisation and equivalence . . . . . . . . . . . . 8 + 3.2.6. Normalization and equivalence . . . . . . . . . . . . 8 3.3. Custom property extensions and values . . . . . . . . . . 9 4. Common JSCalendar properties . . . . . . . . . . . . . . . . 9 4.1. Metadata properties . . . . . . . . . . . . . . . . . . . 9 4.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 9 4.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 10 4.1.3. relatedTo . . . . . . . . . . . . . . . . . . . . . . 10 4.1.4. prodId . . . . . . . . . . . . . . . . . . . . . . . 11 4.1.5. created . . . . . . . . . . . . . . . . . . . . . . . 11 4.1.6. updated . . . . . . . . . . . . . . . . . . . . . . . 11 4.1.7. sequence . . . . . . . . . . . . . . . . . . . . . . 12 4.1.8. method . . . . . . . . . . . . . . . . . . . . . . . 12 4.2. What and where properties . . . . . . . . . . . . . . . . 12 4.2.1. title . . . . . . . . . . . . . . . . . . . . . . . . 12 4.2.2. description . . . . . . . . . . . . . . . . . . . . . 12 - 4.2.3. htmlDescription . . . . . . . . . . . . . . . . . . . 12 + 4.2.3. descriptionContentType . . . . . . . . . . . . . . . 12 4.2.4. locations . . . . . . . . . . . . . . . . . . . . . . 12 - 4.2.5. links . . . . . . . . . . . . . . . . . . . . . . . . 14 - 4.2.6. locale . . . . . . . . . . . . . . . . . . . . . . . 16 - 4.2.7. keywords . . . . . . . . . . . . . . . . . . . . . . 16 - 4.2.8. categories . . . . . . . . . . . . . . . . . . . . . 16 - 4.2.9. color . . . . . . . . . . . . . . . . . . . . . . . . 16 + 4.2.5. virtualLocations . . . . . . . . . . . . . . . . . . 13 + 4.2.6. links . . . . . . . . . . . . . . . . . . . . . . . . 14 + 4.2.7. locale . . . . . . . . . . . . . . . . . . . . . . . 15 + 4.2.8. keywords . . . . . . . . . . . . . . . . . . . . . . 15 + 4.2.9. categories . . . . . . . . . . . . . . . . . . . . . 15 + 4.2.10. color . . . . . . . . . . . . . . . . . . . . . . . . 16 4.3. Recurrence properties . . . . . . . . . . . . . . . . . . 16 - 4.3.1. recurrenceRule . . . . . . . . . . . . . . . . . . . 17 + 4.3.1. recurrenceRule . . . . . . . . . . . . . . . . . . . 16 4.3.2. recurrenceOverrides . . . . . . . . . . . . . . . . . 21 4.3.3. excluded . . . . . . . . . . . . . . . . . . . . . . 22 4.4. Sharing and scheduling properties . . . . . . . . . . . . 22 4.4.1. priority . . . . . . . . . . . . . . . . . . . . . . 22 - 4.4.2. freeBusyStatus . . . . . . . . . . . . . . . . . . . 23 - 4.4.3. privacy . . . . . . . . . . . . . . . . . . . . . . . 23 - 4.4.4. replyTo . . . . . . . . . . . . . . . . . . . . . . . 24 - 4.4.5. participants . . . . . . . . . . . . . . . . . . . . 25 - 4.5. Alerts properties . . . . . . . . . . . . . . . . . . . . 28 - 4.5.1. useDefaultAlerts . . . . . . . . . . . . . . . . . . 28 - 4.5.2. alerts . . . . . . . . . . . . . . . . . . . . . . . 28 - 4.6. Multilingual properties . . . . . . . . . . . . . . . . . 31 - 4.6.1. localizations . . . . . . . . . . . . . . . . . . . . 31 - 5. Type-specific JSCalendar properties . . . . . . . . . . . . . 32 - 5.1. JSEvent properties . . . . . . . . . . . . . . . . . . . 32 - 5.1.1. start . . . . . . . . . . . . . . . . . . . . . . . . 32 - 5.1.2. timeZone . . . . . . . . . . . . . . . . . . . . . . 32 - 5.1.3. duration . . . . . . . . . . . . . . . . . . . . . . 32 - 5.1.4. isAllDay . . . . . . . . . . . . . . . . . . . . . . 33 - 5.1.5. status . . . . . . . . . . . . . . . . . . . . . . . 33 - 5.2. JSTask properties . . . . . . . . . . . . . . . . . . . . 33 - 5.2.1. due . . . . . . . . . . . . . . . . . . . . . . . . . 33 - 5.2.2. start . . . . . . . . . . . . . . . . . . . . . . . . 34 - 5.2.3. timeZone . . . . . . . . . . . . . . . . . . . . . . 34 - 5.2.4. estimatedDuration . . . . . . . . . . . . . . . . . . 34 - 5.2.5. completed . . . . . . . . . . . . . . . . . . . . . . 34 - 5.2.6. isAllDay . . . . . . . . . . . . . . . . . . . . . . 34 - 5.2.7. progress . . . . . . . . . . . . . . . . . . . . . . 35 - 5.2.8. status . . . . . . . . . . . . . . . . . . . . . . . 35 - 5.3. JSGroup properties . . . . . . . . . . . . . . . . . . . 36 - 5.3.1. entries . . . . . . . . . . . . . . . . . . . . . . . 37 - 5.3.2. source . . . . . . . . . . . . . . . . . . . . . . . 37 - 6. Conversion from and to iCalendar . . . . . . . . . . . . . . 37 - 6.1. JSEvent . . . . . . . . . . . . . . . . . . . . . . . . . 37 - 6.2. JSTask . . . . . . . . . . . . . . . . . . . . . . . . . 38 - 6.3. JSGroup . . . . . . . . . . . . . . . . . . . . . . . . . 40 - 6.4. Common properties . . . . . . . . . . . . . . . . . . . . 40 - 6.5. Locations and participants . . . . . . . . . . . . . . . 43 - 6.6. Unknown properties . . . . . . . . . . . . . . . . . . . 45 - 7. JSCalendar object examples . . . . . . . . . . . . . . . . . 46 - 7.1. Simple event . . . . . . . . . . . . . . . . . . . . . . 46 - 7.2. Simple task . . . . . . . . . . . . . . . . . . . . . . . 46 - 7.3. Simple group . . . . . . . . . . . . . . . . . . . . . . 46 - 7.4. All-day event . . . . . . . . . . . . . . . . . . . . . . 47 - 7.5. Task with a due date . . . . . . . . . . . . . . . . . . 47 - 7.6. Event with end time-zone . . . . . . . . . . . . . . . . 48 - 7.7. Floating-time event (with recurrence) . . . . . . . . . . 48 - 7.8. Event with multiple locations and localization . . . . . 49 - 7.9. Recurring event with overrides . . . . . . . . . . . . . 50 - 7.10. Recurring event with participants . . . . . . . . . . . . 51 - 8. Security Considerations . . . . . . . . . . . . . . . . . . . 53 - 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 53 - 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 53 - 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 53 - 11.1. Normative References . . . . . . . . . . . . . . . . . . 53 - 11.2. Informative References . . . . . . . . . . . . . . . . . 55 - 11.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 56 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 56 + 4.4.2. freeBusyStatus . . . . . . . . . . . . . . . . . . . 22 + 4.4.3. privacy . . . . . . . . . . . . . . . . . . . . . . . 22 + 4.4.4. replyTo . . . . . . . . . . . . . . . . . . . . . . . 23 + 4.4.5. participants . . . . . . . . . . . . . . . . . . . . 24 + 4.5. Alerts properties . . . . . . . . . . . . . . . . . . . . 27 + 4.5.1. useDefaultAlerts . . . . . . . . . . . . . . . . . . 27 + 4.5.2. alerts . . . . . . . . . . . . . . . . . . . . . . . 27 + 4.6. Multilingual properties . . . . . . . . . . . . . . . . . 29 + 4.6.1. localizations . . . . . . . . . . . . . . . . . . . . 29 + 5. Type-specific JSCalendar properties . . . . . . . . . . . . . 30 + 5.1. JSEvent properties . . . . . . . . . . . . . . . . . . . 30 + 5.1.1. start . . . . . . . . . . . . . . . . . . . . . . . . 30 + 5.1.2. timeZone . . . . . . . . . . . . . . . . . . . . . . 30 + 5.1.3. duration . . . . . . . . . . . . . . . . . . . . . . 30 + 5.1.4. isAllDay . . . . . . . . . . . . . . . . . . . . . . 31 + 5.1.5. status . . . . . . . . . . . . . . . . . . . . . . . 31 + 5.2. JSTask properties . . . . . . . . . . . . . . . . . . . . 31 + 5.2.1. due . . . . . . . . . . . . . . . . . . . . . . . . . 31 + 5.2.2. start . . . . . . . . . . . . . . . . . . . . . . . . 31 + 5.2.3. timeZone . . . . . . . . . . . . . . . . . . . . . . 32 + 5.2.4. estimatedDuration . . . . . . . . . . . . . . . . . . 32 + 5.2.5. completed . . . . . . . . . . . . . . . . . . . . . . 32 + 5.2.6. isAllDay . . . . . . . . . . . . . . . . . . . . . . 32 + 5.2.7. progress . . . . . . . . . . . . . . . . . . . . . . 33 + 5.2.8. status . . . . . . . . . . . . . . . . . . . . . . . 33 + 5.3. JSGroup properties . . . . . . . . . . . . . . . . . . . 34 + 5.3.1. entries . . . . . . . . . . . . . . . . . . . . . . . 35 + 5.3.2. source . . . . . . . . . . . . . . . . . . . . . . . 35 + 6. Conversion from and to iCalendar . . . . . . . . . . . . . . 35 + 6.1. JSEvent . . . . . . . . . . . . . . . . . . . . . . . . . 35 + 6.2. JSTask . . . . . . . . . . . . . . . . . . . . . . . . . 36 + 6.3. JSGroup . . . . . . . . . . . . . . . . . . . . . . . . . 38 + 6.4. Common properties . . . . . . . . . . . . . . . . . . . . 38 + 6.5. Locations and participants . . . . . . . . . . . . . . . 40 + 6.6. Unknown properties . . . . . . . . . . . . . . . . . . . 43 + 7. JSCalendar object examples . . . . . . . . . . . . . . . . . 43 + 7.1. Simple event . . . . . . . . . . . . . . . . . . . . . . 43 + 7.2. Simple task . . . . . . . . . . . . . . . . . . . . . . . 44 + 7.3. Simple group . . . . . . . . . . . . . . . . . . . . . . 44 + 7.4. All-day event . . . . . . . . . . . . . . . . . . . . . . 44 + 7.5. Task with a due date . . . . . . . . . . . . . . . . . . 45 + 7.6. Event with end time-zone . . . . . . . . . . . . . . . . 45 + 7.7. Floating-time event (with recurrence) . . . . . . . . . . 46 + 7.8. Event with multiple locations and localization . . . . . 46 + 7.9. Recurring event with overrides . . . . . . . . . . . . . 47 + 7.10. Recurring event with participants . . . . . . . . . . . . 48 + 8. Security Considerations . . . . . . . . . . . . . . . . . . . 50 + 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 50 + 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 50 + 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 50 + 11.1. Normative References . . . . . . . . . . . . . . . . . . 50 + 11.2. Informative References . . . . . . . . . . . . . . . . . 52 + 11.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 53 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 53 1. Introduction This document defines a data model for calendar event and task objects, or groups of such objects, in electronic calendar applications and systems. It aims to be unambiguous, extendable and simple to process. The key design considerations for this data model are as follows: @@ -256,22 +257,22 @@ The @type (Section 4.1.1) property value MUST be "jsgroup". 3. Structure of JSCalendar objects A JSCalendar object is a JSON object, which MUST be valid I-JSON (a stricter subset of JSON), as specified in [RFC8259]. Property names and values are case-sensitive. The object has a collection of properties, as specified in the following sections. Unless otherwise specified, all properties are - optional; omitted properties MUST be treated identically to if that - property had the value of "null", unless otherwise specified. + mandatory. Optional properties may have a default value, if + explicitly specified in the property definition. 3.1. Type signatures Types signatures are given for all JSON objects in this document. The following conventions are used: o "Boolean|String": The value is either a JSON "Boolean" value, or a JSON "String" value. o "Foo": Any name that is not a native JSON type means an object for @@ -317,26 +318,26 @@ A duration is represented by a subset of ISO8601 duration format, as specified by the following ABNF: dur-secfrac = "." 1*DIGIT dur-second = 1*DIGIT [dur-secfrac] "S" dur-minute = 1*DIGIT "M" [dur-second] dur-hour = 1*DIGIT "H" [dur-minute] dur-time = "T" (dur-hour / dur-minute / dur-second) dur-day = 1*DIGIT "D" + dur-week = 1*DIGIT "W" - duration = "P" (dur-day [dur-time] / dur-time) + duration = "P" (dur-day [dur-time] / dur-time / dur-week) In addition, the duration MUST NOT include fractional second values - unless the fraction is non-zero. A zero duration MUST be represented - as "P0D". + unless the fraction is non-zero. 3.2.4. PatchObject A *PatchObject* is of type "String[*|null]", and represents an unordered set of patches on a JSON object. The keys are a path in a subset of [RFC6901] JSON pointer format, with an implicit leading "/" (i.e. prefix each key with "/" before applying the JSON pointer evaluation algorithm). A patch within a PatchObject is only valid, if all of the following @@ -344,21 +345,21 @@ 1. The pointer MUST NOT reference inside an array (i.e. it MUST NOT insert/delete from an array; the array MUST be replaced in its entirety instead). 2. When evaluating a path, all parts prior to the last (i.e. the value after the final slash) MUST exist. 3. There MUST NOT be two patches in the PatchObject where the pointer of one is the prefix of the pointer of the other, e.g. - "alerts/1/offset" and "alerts". + "alerts/foo/offset" and "alerts". The value associated with each pointer is either: o "null": Remove the property from the patched object. If not present in the parent, this a no-op. o Anything else: The value to replace the inherited property on the patch object with (if present) or add to the property (if not present). @@ -367,65 +368,65 @@ 3.2.5. Identifiers If not noted otherwise, properties that define identifiers MUST be string values, MUST be at least 1 character in length and maximum 256 octets in size, and MUST only contain characters from the "URL and Filename safe" Base 64 Alphabet, as defined in section 5 of [RFC4648]. This is the ASCII alphanumeric characters (A-Za-z0-9), hyphen (-), and underscore (_). -3.2.6. Normalisation and equivalence +3.2.6. Normalization and equivalence JSCalendar aims to provide unambiguous definitions for value types - and properties, but does not define a general normalisation or + and properties, but does not define a general normalization or equivalence method for JSCalendar objects and types. This is because the notion of equivalence might range from byte-level equivalence to semantic equivalence, depending on the respective use case (for example, the CalDAV protocol [RFC4791] requires octet equivalence of the encoded calendar object to determine ETag equivalence). - Normalisation of JSCalendar objects is hindered because of the + Normalization of JSCalendar objects is hindered because of the following reasons: o Custom JSCalendar properties may contain arbitrary JSON values, including arrays. However, equivalence of arrays might or might not depend on the order of elements, depending on the respective property definition. o Several JSCalendar property values are defined as URIs and MIME - types, but normalisation of these types is inherently protocol and + types, but normalization of these types is inherently protocol and scheme-specific, depending on the use-case of the equivalence definition (see section 6 of [RFC3986]). - Considering this, the definition of equivalence and normalisation is + Considering this, the definition of equivalence and normalization is left to client and server implementations and to be negotiated by a calendar exchange protocol or defined by another RFC. 3.3. Custom property extensions and values Vendors MAY add additional properties to the calendar object to support their custom features. The names of these properties MUST be prefixed with a domain name controlled by the vendor to avoid conflict, e.g. "example.com/customprop". Some JSCalendar properties allow vendor-specific value extensions. If so, vendor specific values MUST be prefixed with a domain name controlled by the vendor, e.g. "example.com/customrel", unless otherwise noted. 4. Common JSCalendar properties This section describes the properties that are common to the various JSCalendar object types. Specific JSCalendar object types may only support a subset of these properties. The object type definitions in - section Section 5 describe the set of supported properties per type. + Section 5 describe the set of supported properties per type. 4.1. Metadata properties 4.1.1. @type Type: "String" Specifies the type which this object represents. This MUST be one of the following values, registered in a future RFC, or a vendor- specific value: @@ -451,21 +452,21 @@ For compatibility with [RFC5545] UIDs, implementations MUST be able to receive and persist values of at least 255 octets for this property, but they MUST NOT truncate values in the middle of a UTF-8 multi-octet sequence. A valid JSCalendar object MUST include this property. 4.1.3. relatedTo - Type: "String[Relation]|null" + Type: "String[Relation]" (optional) Relates the object to other JSCalendar objects. This is represented as a map of the uids of the related objects to information about the relation. A *Relation* object has the following properties: o *relation*: "String[]" Describes how the linked object is related to this object. @@ -487,279 +488,257 @@ previous occurrence before this split, and a new object created to represent all the objects after the split. A "relation=["next"]" relatedTo property MUST be set on the original object with the uid of the new object. A "relation=["first"]" relatedTo property with the UID of the first object in the series MUST be set on the new object. Clients can then follow these UIDs to get the complete set of objects if the user wishes to modify them all at once. 4.1.4. prodId - Type: "String|null" + Type: "String" (optional) The identifier for the product that created the JSCalendar object. The vendor of the implementation SHOULD ensure that this is a globally unique identifier, using some technique such as an FPI value, as defined in [ISO.9070.1991]. It MUST only use characters of an iCalendar TEXT data value (see section 3.3.11 in [RFC5545]). This property SHOULD NOT be used to alter the interpretation of an JSCalendar object beyond the semantics specified in this document. For example, it is not to be used to further the understanding of non-standard properties. 4.1.5. created - Type: "UTCDate|null" + Type: "UTCDate" (optional) The date and time this object was initially created. 4.1.6. updated Type: "UTCDate" The date and time the data in this object was last modified. 4.1.7. sequence - Type: "Number" (Defaults to "0" if omitted) + Type: "Number" (optional, default:"0") Initially zero, this MUST be a non-negative integer that is monotonically incremented each time a change is made to the object. 4.1.8. method - Type: "String|null" + Type: "String" (optional) The iTIP ([RFC5546]) method, in lower-case. Used for scheduling. 4.2. What and where properties 4.2.1. title - Type: "String" (Defaults to the empty string if omitted) + Type: "String" (optional, default:"""") A short summary of the object. 4.2.2. description - Type: "String" (Defaults to the empty string if omitted) + Type: "String" (optional, default:"""") - A longer form description of the object. This is plain text, but a - client SHOULD attempt to hyperlink URLs when displaying it. + A longer-form text description of the object. The content is + formatted according to the *descriptionContentType* property. -4.2.3. htmlDescription +4.2.3. descriptionContentType - Type: "String|null" (Defaults to null if omitted) + Type: "String" (optional, default:"text/plain" - A longer form rich-text description of the object. This is HTML text - [1] and allows to reference resources in the *links* property by use - of CID URLs (see [RFC2392]). To convert a CID URL to the *cid* - property value of a *Link* object, implementations MUST follow the - conversion described in section 2 of [RFC2392]. Implementations MAY - choose not to follow untrusted external CID URLs referenced in the - *links* property, in which case they MUST treat the *htmlDescription* - property as if omitted. Implementations MUST preserve the value of - this property, even if it contains untrusted links. + Describes the media type ([RFC6838]) of the contents of the + "description" property. Media types MUST be sub-types of type + "text", and SHOULD be "text/plain" or "text/html" ([MIME]). They MAY + define parameters and the "charset" parameter MUST be "utf-8", if + specified. Descriptions of type "text/html" MAY contain "cid" URLs + ([RFC2392]) to reference links in the calendar object by use of the + *cid* property of the *Link* object. 4.2.4. locations - Type: "String[Location]|null" + Type: "String[Location]" (optional) A map of location ids to Location objects, representing locations associated with the object. A location id may be any valid [RFC6901] JSON pointer and need only be unique to this object; a UUID is a practical choice. - A *Location* object has the following properties. All properties are - optional, but every Location object MUST have at least one property: + A *Location* object has the following properties. It must define at + least one other property than *rel*. - o *name*: "String" (Defaults to the empty string if omitted) The - human-readable name of the location. + o *name*: "String" (optional, default:"""") The human-readable name + of the location. - o *description*: "String|null" Human-readable instructions for - accessing this location. This may be an address, set of - directions, door access code, etc. + o *description*: "String" (optional) Human-readable, plain-text + instructions for accessing this location. This may be an address, + set of directions, door access code, etc. - o *rel*: "String" (Defaults to "unknown" if omitted) The relation - type of this location to the JSCalendar object. + o *rel*: "String" (optional) The relation type of this location to + the JSCalendar object. This MUST be either one of the following values, registered in a future RFC, or a vendor-specific value. Any value the client or - server doesn't understand should be treated the same as "unknown". + server doesn't understand should be treated the same as if this + property is omitted. * "start": The JSCalendar object starts at this location. * "end": The JSCalendar object ends at this location. - * "virtual": This is not a physical location (e.g. this location - is an online chat room where people will meet). + o *timeZone*: "String" (optional) A time-zone for this location. - * "unknown": The relation of this location to the calendar object - is unknown. + If omitted, the *timeZone* from the JSCalendar object MUST be + presumed when a time-zone is needed in relation to this location. - o *features*: "String[]|null" The features supported by this + o *coordinates*: "String" (optional) An [RFC5870] "geo:" URI for the location. - The strings in the array MUST each be either one of the following - values, registered in a future RFC, or a vendor-specific value. - Any value the client or server doesn't understand should be - ignored, but preserved. - - The features supported by locations with rel-type "virtual" are: - - * "audio": audio conferencing - - * "chat": chat or instant messaging - - * "feed": blog or atom feed + o *linkIds*: "String[]" (optional) A list of ids for links to + alternate representations of this location. - * "moderator": provides moderator-specific features - * "phone": phone conferencing + For example, an alternative representation could be in vCard + format. - * "screen": screen sharing +4.2.5. virtualLocations - * "video": video conferencing + Type: "String[VirtualLocation]" (optional) - * any vendor-prefixed custom value + A map of ids to VirtualLocation objects, representing virtual + locations, such as video conferences or chat rooms, associated with + the object. A virtual location id may be any valid [RFC6901] JSON + pointer and need only be unique to this object; a UUID is a practical + choice. - o *timeZone*: "String|null" (Defaults to "null" if omitted) A time- - zone for this location. + A *VirtualLocation* object has the following properties. - If "null", the *timeZone* from the JSCalendar object MUST be - presumed when a time-zone is needed in relation to this location. + o *name*: "String" (optional, default:"""") The human-readable name + of the virtual location. - o *coordinates*: "String|null" An [RFC5870] "geo:" URI for the - location. + o *description*: "String" (optional) Human-readable plain-text + instructions for accessing this location. This may be an address, + set of directions, door access code, etc. - o *uri*: "String|null" A URI that represents how to connect to this - location. + o *uri*: "String" A URI that represents how to connect to this + virtual location. This may be a telephone number (represented as "tel:+1-555-555-555") for a teleconference, a web address for online chat, or any custom URI. - o *linkIds*: "String[]|null" A list of ids for links to alternate - representations of this location. - - For example, an alternative representation could be in vCard - format. - -4.2.5. links +4.2.6. links - Type: "String[Link]|null" + Type: "String[Link]" (optional) A map of link ids to Link objects, representing external resources associated with the object. A link id may be any valid [RFC6901] JSON pointer and need only be unique to this object; the href or a UUID are practical choices. A *Link* object has the following properties: o *href*: "String" A URI from which the resource may be fetched. This MAY be a "data:" URL, but it is recommended that the file be - hosted on a server to avoid embedding arbitrary large data in + hosted on a server to avoid embedding arbitrarily large data in JSCalendar object instances. - o *cid* "String|null" The id used within the *htmlDescription* - property to reference this link. - - If not null, this MUST be a valid Content-ID MIME header value - without CFWS and angle brackets (see [RFC2392]). The identifier - MUST be unique within this JSCalendar object but has no meaning - beyond that. Specifically, it MAY be different from the *Link* - object identifier in the enclosing *links* property. + o *cid* "String" (optional) This MUST be a valid "content-id" value + according to the definition of section 2 in [RFC2392]. The + identifier MUST be unique within this JSCalendar object but has no + meaning beyond that. Specifically, it MAY be different from the + link identifier in the enclosing *links* property. - o *type*: "String|null"(optional, defaults to "null") The content- - type [RFC6838] of the resource, if known. + o *type*: "String" (optional) The content-type [RFC6838] of the + resource, if known. - o *size*: "Number|null"(optional, defaults to "null") The size, in - bytes, of the resource when fully decoded (i.e. the number of - bytes in the file the user would download), if known. + o *size*: "Number" (optional) The size, in bytes, of the resource + when fully decoded (i.e. the number of bytes in the file the user + would download), if known. - o *rel*: "String"(optional, defaults to "related") Identifies the - relation of the linked resource to the object. The value MUST be - a registered relation type (see [RFC8288] and IANA Link Relations - [2]). + o *rel*: "String" (optional) Identifies the relation of the linked + resource to the object. If set, the value MUST be a registered + relation type (see [RFC8288] and IANA Link Relations [1]). Links with a rel of "enclosure" SHOULD be considered by the client as attachments for download. Links with a rel of "describedby" SHOULD be considered by the - client to be an alternate representation of the description and - HTML description. + client to be an alternate representation of the description. Links with a rel of "icon" SHOULD be considered by the client to be an image that it MAY use when presenting the calendar data to a - user. The *properties* object of this link MAY include a - "display" property indicating the intended purpose of this image. - If included, the value MUST be either one of the following values, - registered in a future RFC, or a vendor-specific value. + user. The *display* property MAY be set to indicate the purpose + of this image. + + o *display*: "String" (optional) Describes the intended purpose of a + link to an image. If set, the *rel* property MUST be set to + "icon". The value MUST be either one of the following values, + registered in a future RFC, or a vendor-specific value: * "badge": an image inline with the title of the object * "graphic": a full image replacement for the object itself * "fullsize": an image that is used to enhance the object * "thumbnail": a smaller variant of "fullsize " to be used when space for the image is constrained - o *title*: "String|null"(optional, defaults to "null") A human- - readable description of the resource. - - o *properties*: "String[String|null]|null"(optional, defaults to - "null") Extra metadata submitted by clients about a link. Server - implementations MUST preserve these properties. - - The keys are as defined in this document, as defined in a future - RFC, or URIs that should be owned by the client author to avoid - conflicts. + o *title*: "String" (optional) A human-readable plain-text + description of the resource. -4.2.6. locale +4.2.7. locale - Type: "String|null" + Type: "String" (optional) The [RFC5646] language tag that best describes the locale used for the calendar object, if known. -4.2.7. keywords - - Type: "String[]|null" +4.2.8. keywords - A list of keywords or tags related to the object. The values are - free-form and do not have to follow any particular structure. + Type: "String[Boolean]" (optional) -4.2.8. categories + A set of keywords or tags that relate to the object. The set is + represented as a map, with the keys being the keywords. The value + for each key in the map MUST be "true". - Type: "String[]|null" +4.2.9. categories - Specifies the categories related to the calendar object. Array - values MUST be URIs. In contrast to *keywords*, categories typically - are structured. + Type: "String[Boolean]" (optional) + A set of categories that relate to the calendar object. The set is + represented as a map, with the keys being the categories specified as + URIs. The value for each key in the map MUST be "true". - For example, a vendor owning the domain "example.com" might define - the categories "http://example.com/categories/sports/american- - football"" and "http://example.com/categories/music/r-b". + In contrast to *keywords*, categories typically are structured. For + example, a vendor owning the domain "example.com" might define the + categories "http://example.com/categories/sports/american-football"" + and "http://example.com/categories/music/r-b". -4.2.9. color +4.2.10. color - Type: "String|null" + Type: "String" (optional) Specifies a color clients MAY use when displaying this calendar object. The value is a case-insensitive color name taken from the CSS3 set of names, defined in Section 4.3 of W3C.REC- - css3-color-20110607 [3] or a CSS3 RGB color hex value. + css3-color-20110607 [2] or a CSS3 RGB color hex value. 4.3. Recurrence properties + 4.3.1. recurrenceRule Type: "Recurrence" Defines a recurrence rule (repeating pattern) for recurring calendar objects. A *Recurrence* object is a JSON object mapping of a RECUR value type in iCalendar, see [RFC5545] and[RFC7529]. A JSEvent recurs by applying the recurrence rule (and *recurrenceOverrides*) to the @@ -773,57 +752,56 @@ o *frequency*: "String" This MUST be one of the following values: * "yearly" * "monthly" * "weekly" * "daily" - * "hourly" * "minutely" * "secondly" To convert from iCalendar, simply lower-case the FREQ part. - o *interval*: "Number"(optional, defaults to "1") The INTERVAL part - from iCal. If included, it MUST be an integer "x >= 1". + o *interval*: "Number"(optional, default:"1") The INTERVAL part from + iCal. If included, it MUST be an integer "x >= 1". - o *rscale*: "String"(optional, defaults to ""gregorian"") The RSCALE + o *rscale*: "String"(optional, default:""gregorian"") The RSCALE part from iCalendar RSCALE [RFC7529], converted to lower-case. - o *skip*: "String"(optional, defaults to ""omit"") The SKIP part - from iCalendar RSCALE [RFC7529], converted to lower-case. + o *skip*: "String"(optional, default:""omit"") The SKIP part from + iCalendar RSCALE [RFC7529], converted to lower-case. - o *firstDayOfWeek*: "String"(optional, defaults to ""mo"") The WKST - part from iCalendar, represented as a lower-case abbreviated two- - letter English day of the week. If included, it MUST be one of - the following values: ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". + o *firstDayOfWeek*: "String"(optional, default:""mo"") The WKST part + from iCalendar, represented as a lower-case abbreviated two-letter + English day of the week. If included, it MUST be one of the + following values: ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". o *byDay*: "NDay[]"(optional) An *NDay* object has the following properties: * *day*: "String" The day-of-the-week part of the BYDAY value in iCalendar, lower-cased. MUST be one of the following values: ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". - * *nthOfPeriod*: "Number"(optional) The optional ordinal part of - the BYDAY value in iCalendar (e.g. ""+1"" or ""-3""). If - present, rather than representing every occurrence of the - weekday defined in the *day* property of this *NDay*, it - represents only a specific instance within the recurrence - period. The value can be positive or negative, but MUST NOT be - zero. A negative integer means nth-last of period. + * *nthOfPeriod*: "Number" (optional) The ordinal part of the + BYDAY value in iCalendar (e.g. ""+1"" or ""-3""). If present, + rather than representing every occurrence of the weekday + defined in the *day* property of this *NDay*, it represents + only a specific instance within the recurrence period. The + value can be positive or negative, but MUST NOT be zero. A + negative integer means nth-last of period. o *byMonthDay*: "Number[]"(optional) The BYMONTHDAY part from iCalendar. The array MUST have at least one entry if included. o *byMonth*: "String[]"(optional) The BYMONTH part from iCalendar. Each entry is a string representation of a number, starting from "1" for the first month in the calendar (e.g. ""1" " means ""January"" with Gregorian calendar), with an optional ""L"" suffix (see [RFC7529]) for leap months (this MUST be upper-case, e.g. ""3L""). The array MUST have at least one entry if included. @@ -970,21 +948,21 @@ + if there is no byMonthDate property: Add a byMonthDay property with the sole value being the day-of-the-month of the start date-time. + if there is no byMonth property: Add a byMonth property with the sole value being the month of the start date-time. 4.3.2. recurrenceOverrides - Type: "LocalDate[PatchObject|null]|null" + Type: "LocalDate[PatchObject]" (optional) A map of the recurrence-ids (the date-time of the start of the occurrence) to an object of patches to apply to the generated occurrence object. If the recurrence-id does not match an expanded start date from a recurrence rule, it is to be treated as an additional occurrence (like an RDATE from iCalendar). The patch object may often be empty in this case. @@ -1018,59 +996,59 @@ o isAllDay o recurrenceRule o recurrenceOverrides o replyTo 4.3.3. excluded - Type: "Boolean"(defaults to "false" if omitted) + Type: "Boolean" (optional, default:"false") Defines if this object is an overridden, excluded instance of a recurring JSCalendar object (also see Section 4.3.2). If this property value is "true", this calendar object instance MUST be treated as if not existent. 4.4. Sharing and scheduling properties 4.4.1. priority - Type: "Number"(defaults to "0" if omitted) + Type: "Number" (optional, default:"0") Specifies a priority for the calendar object. This may be used as part of scheduling systems to help resolve conflicts for a time period. 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. Other integer values are reserved for future use. 4.4.2. freeBusyStatus - Type: "String"(defaults to "busy" if omitted) + Type: "String"(optional, default:"busy") Specifies how this property should be treated when calculating free- busy state. The value MUST be one of: o ""free"": The object should be ignored when calculating whether the user is busy. o ""busy"": The object should be included when calculating whether the user is busy. 4.4.3. privacy - Type: "String"(defaults to "public" if omitted) + Type: "String"(optional, default:"public") Calendar objects are normally collected together and may be shared with other users. The privacy property allows the object owner to indicate that it should not be shared, or should only have the time information shared but the details withheld. Enforcement of the restrictions indicated by this property are up to the implementations. This property MUST NOT affect the information sent to scheduled participants; it is only interpreted when the object is shared as @@ -1088,367 +1066,293 @@ o "private": The details of the object are hidden; only the basic time and metadata is shared. Implementations MUST ensure the following properties are stripped when the object is accessed by a sharee: * title * description - * htmlDescription - * locations * links * locale * localizations * participants * replyTo In addition, any patches in "recurrenceOverrides" whose key is prefixed with one of the above properties MUST be stripped. o "secret": The object is hidden completely (as though it did not exist) when the calendar is shared. 4.4.4. replyTo - Type: "String[String]|null" + Type: "String[String]" (optional) - Represents methods by which a participant may RSVP to the organizer - of the calendar object. The keys in the property value are the - available methods. The value is a URI to use that method. Future - methods may be defined in future specifications; a calendar client - MUST ignore any method it does not understand. + Represents methods by which participants may submit their RSVP + response to the organizer of the calendar object. The keys in the + property value are the available methods. The value is a URI to use + that method. Future methods may be defined in future specifications; + a calendar client MUST ignore any method it does not understand. The following methods are defined: o "imip": The organizer accepts an iMIP [RFC6047] response. The value MUST be a "mailto:" URI. - o "web": There is a web page where the user may submit an RSVP using - their browser. The value MUST be a "https:" URI Template - ([RFC6570]) in level 1 format. The template MAY contain variables - that MUST be expanded from the JSCalendar object as defined in - table Table 1. Calendar clients SHOULD be prepared to handle - authentication requests from the respective web page and for the - participant email, but this specification does not mandate any - specific mechanism. + o "web": There is a web page where the user may submit the RSVP + response using a browser. The value MUST be a "https:" URI + Template ([RFC6570]) in level 1 format. The template MAY contain + variables that MUST be expanded from the JSCalendar object as + defined in table Table 1. Calendar clients SHOULD be prepared to + handle authentication requests from the respective web page and + for the participant email, but this specification does not mandate + any specific mechanism. +--------------+----------------------------------------------------+ | Variable | Expand to | +--------------+----------------------------------------------------+ | email | The *email* property value of the replying | | | *Participant* object. | | | | | uid | The *uid* property value of the JSCalendar object. | | | | | sequence | The *sequence* property value of the JSCalendar | | | object. | | | | | recurrenceId | The recurrence-id when replying for a single | | | occurrence of a recurring JSCalendar object. The | | | LocalDate-typed value is the recurrence-id of a | - | | non-overriden recurrence, or the key of a | + | | non-overridden recurrence, or the key of a | | | recurrenceOverride of this JSCalendar object. | +--------------+----------------------------------------------------+ Table 1: replyTo URI Template variables 4.4.5. participants - Type: "String[Participant]|null" + Type: "String[Participant]" (optional) A map of participant ids to participants, describing their participation in the calendar object. A participant id may be any valid [RFC6901] JSON pointer and need only be unique to this calendar object; the email address of the participant is a good choice. - A *Participant* object has the following properties. Properties are - mandatory unless marked otherwise: + A *Participant* object has the following properties: o *name*: "String" The display name of the participant (e.g. "Joe Bloggs"). o *email*: "String" The email address for the participant. - o *kind*: "String"(optional, defaults to "unknown") What kind of - entity this participant is. + o *kind*: "String" (optional) What kind of entity this participant + is, if known. This MUST be either one of the following values, registered in a future RFC, or a vendor-specific value. Any value the client or - server doesn't understand should be treated the same as "unknown". + server doesn't understand should be treated the same as if this + property is omitted. * "individual": a single person * "group": a collection of people invited as a whole + * "resource": a non-human resource, e.g. a projector * "location": a physical location involved in the calendar object that needs to be scheduled, e.g. a conference room. - * "unknown": no information is available about the kind of this - participant. - - o *roles*: "String[]" A list of roles that this participant fulfils. + o *roles*: "String[]" A list of roles that this participant + fulfills. At least one value MUST be specified for the participant. This MUST be either one of the following values, registered in a future RFC, or a vendor-specific value. Any value the client or server doesn't understand should be preserved but ignored. - * "owner": The participant is an owner of the object, and allowed - to make alterations to any part of it. + * "owner": The participant is an owner of the object. * "attendee": The participant is an attendee of the calendar - object. Attendees are only allowed to alter their own - participation. + object. * "chair": The participant is in charge of the calendar object when it occurs. - o *locationId*: "String|null"(optional, defaults to "null") The - location at which this participant is expected to be attending. + o *locationId*: "String" (optional) The location at which this + participant is expected to be attending. If the value does not correspond to any location id in the - locations property of the instance, this MUST be treated the same - as if the participant's locationId were specified as null. + *locations* property of the instance, this MUST be treated the + same as if the participant's locationId were omitted. - o *rsvpResponse*: "String"(optional, defaults to "needs-action") The + o *rsvpResponse*: "String"(optional, default:"needs-action") The RSVP response, if any, of this participant. The value MUST be either one of the following values, registered in a future RFC, or a vendor-specific value: * "needs-action": No status yet set by the participant. * "accepted": The invited participant will participate. * "declined": The invited participant will not participate. * "tentative": The invited participant may participate. - o *participation*: "String"(optional, defaults to "required") The + o *participation*: "String"(optional, default:"required") The required participation of this participant. The value MUST be either one of the following values, registered in a future RFC, or a vendor-specific value. Any value the client or server doesn't understand should be treated the same as "required". * "non-participant": Indicates a participant who is copied for information purposes only. * "optional": Indicates a participant whose participation is optional. * "required": Indicates a participant whose participation is required. - o *rsvpWanted*: "Boolean"(optional, defaults to "false") If true, - the organizer is expecting the participant to notify them of their + o *rsvpWanted*: "Boolean"(optional, default:"false") If true, the + organizer is expecting the participant to notify them of their status. - o *scheduleSequence*: "Number"(optional, defaults to "0") The - sequence number of the last response from the participant. If - defined, this MUST be a non-negative integer. + o *scheduleSequence*: "Number"(optional, default:"0") The sequence + number of the last response from the participant. If defined, + this MUST be a non-negative integer. - This can be used to determine whether the partcipant has sent a + This can be used to determine whether the participant has sent a new RSVP following significant changes to the calendar object, and to determine if future responses are responding to a current or older view of the data. - o *scheduleUpdated*: "UTCDate|null"(optional, defaults to "null") - The *updated* property of the last iMIP response from the - participant. + o *scheduleUpdated*: "UTCDate" (optional) The *updated* property of + the last iMIP response from the participant. This can be compared to the *updated* timestamp in future iMIP responses to determine if the response is older or newer than the current data. - o *invitedBy*: "String|null"(optional, defaults to "null") The - participant id of the participant who invited this one, if known. + o *invitedBy*: "String" (optional) The participant id of the + participant who invited this one, if known. - o *delegatedTo*: "String[]|null"(optional, defaults to "null") A - list of participant ids of participants that this participant has - delegated their participation to. This MUST be omitted if none - (rather than an empty array). + o *delegatedTo*: "String[]" (optional) A list of participant ids of + participants that this participant has delegated their + participation to. This MUST be omitted if none (rather than an + empty array). - o *delegatedFrom*: "String[]|null"(optional, defaults to "null") A - list of participant ids that this participant is acting as a - delegate for. This MUST be omitted if none (rather than an empty - array). + o *delegatedFrom*: "String[]" (optional) A list of participant ids + that this participant is acting as a delegate for. This MUST be + omitted if none (rather than an empty array). - o *memberOf*: "String[]|null"(optional, defaults to "null") A list - of group participants that were invited to this calendar object, - which caused this participant to be invited due to their - membership of the group(s). This MUST be omitted if none (rather - than an empty array). + o *memberOf*: "String[]" (optional) A list of group participants + that were invited to this calendar object, which caused this + participant to be invited due to their membership of the group(s). + This MUST be omitted if none (rather than an empty array). - o *linkIds*: "String[]|null"(optional, defaults to "null") Links to - more information about this participant, for example in vCard - format. + o *linkIds*: "String[]" (optional) Links to more information about + this participant, for example in vCard format. 4.5. Alerts properties 4.5.1. useDefaultAlerts - Type: "Boolean" (defaults to "false" if omitted) + Type: "Boolean" (optional, default:"false") If "true", use the user's default alerts and ignore the value of the *alerts* property. Fetching user defaults is dependent on the API from which this JSCalendar object is being fetched, and is not defined in this specification. If an implementation cannot determine the user's default alerts, or none are set, it MUST process the alerts property as if useDefaultAlerts is set to "false". 4.5.2. alerts - Type: "String[Alert]|null" + Type: "String[Alert]" (optional) A map of alert ids to Alert objects, representing alerts/reminders to display or send the user for this calendar object. An alert id may be any valid [RFC6901] JSON pointer and need only be unique to this calendar object; a globally unique id is a practical choice (also see Section 4.1.2)). An *Alert* Object has the following properties: - o *relativeTo*: "String" (optional, defaults to "before-start") + o *relativeTo*: "String" (optional, default:"before-start") Specifies where the offset is relative to for the alarm to trigger. The value MUST be one of: * "before-start" * "after-start" * "before-end" * "after-end" o *offset*: "Duration" The offset from the start and end/due of the calendar object to fire the alert. If the calendar object does not define a time-zone, the user's default time-zone SHOULD be used when determining the offset, if known. Otherwise, the time- zone to use is implementation specific. - o *action*: "DisplayAction|EmailAction|UnknownAction" - - Describes how to alert the user. - - A *DisplayAction* means a message (which is service dependent, but - SHOULD include the title and start or due time of the calendar - object) SHOULD be shown to the user on any client connected to - this account at the specified time. How this message is formatted - (and any sound or other method of drawing the user's attention) is - client specific. It has the following properties: - - * *type*: "String" The value MUST be "display". - - * *acknowledged*: "UTCDate|null " (optional) + o *acknowledged*: "UTCDate" (optional) - When the user has permanently dismissed the alert the client - MUST set this to the current time in UTC. Other clients which - sync this property can then automatically dismiss or suppress - duplicate alerts (alerts with the same alert id that triggered - on or before this date-time). + When the user has permanently dismissed the alert the client MUST + set this to the current time in UTC. Other clients which sync + this property can then automatically dismiss or suppress duplicate + alerts (alerts with the same alert id that triggered on or before + this date-time). For a recurring calendar object, the *acknowledged* property of the parent object MUST be updated, unless the alert is already overridden in *recurrenceOverrides*. - * *snoozed*: "UTCDate|null" (optional) - - If the user temporarily dismisses the alert, this is the UTC - date-time after which it should be reshown. Clients displaying - this alert SHOULD hide it if the snoozed property is updated to - a time in the future. When that time is reached, the alert - SHOULD be reshown unless acknowledged is now after the original - trigger time. - - Setting this property on an instance of a recurring calendar - object MUST update the alarm on the master object, unless the - respective instance already is defined in - "recurrenceOverrides". It MUST NOT generate an override for - the sole use of snoozing an alarm. - - * *mediaLinks*: "String[Link]|null " (optional) - A map of link identifiers to links (see Section 4.2.5) that - contain media to display with this alert. Clients SHOULD play - one or more of the link contents that are supported by the - client implementation and are appropriate for the given device - and user context. - - An *EmailAction* means an email SHOULD be sent as specified in the - object at the specified time. It has the following properties: - - * *type*: "String" The value MUST be "email". - - * *to*: "Emailer[]" An array of name/email objects to send the - alert to. - - An *Emailer* object has the following properties: - - + name: String The name of the recipient. If not known, - clients SHOULD use the empty string. - - + email: String The email address of the recipient. + o *snoozed*: "UTCDate" (optional) - * *subject*: "String" (optional) The subject to use for the - email. If omitted, this is implementation specific, but the - server SHOULD try to choose an appropriate subject, e.g. by - including the summary. + If the user temporarily dismisses the alert, this is the UTC date- + time after which it should trigger again. Setting this property + on an instance of a recurring calendar object MUST update the + alarm on the master object, unless the respective instance already + is defined in "recurrenceOverrides". It MUST NOT generate an + override for the sole use of snoozing an alarm. - * *textBody*: "String" (optional) The plain-text body to use for - the email. If omitted, the body of the email is implementation - specific, but the server SHOULD include all pertinent details - about the calendar object, such as summary, location and start - time. + o *action*: "String" (optional, default:"display") Describes how to + alert the user. - * *htmlBody*: "String" (optional) The HTML body to use for the - email, with rich-media content processed as for the - *htmlDescription* property of the JSCalendar object (see - Section 4.2.3), e.g. all CID URLs MUST be embedded in the - generated alert email HTML body, or the *htmlBody* property - ignored completely. If the textBody property of this alert - action is not set, the server SHOULD generate a plain-text - version from the HTML body and include it in a "multipart/ - alternative" MIME message. + The value MUST be at most one of the following values, registered + in a future RFC, or a vendor-specific value: - * *attachments*: "String[Link]|null" (optional) A map of link - identifiers to links (see Section 4.2.5). Included attachments - SHOULD be embedded in the MIME message with the "Content- - Disposition" header value set to "attachment" (see [RFC2183]). - Implementations MAY refuse to include one or more attachments - when building an alert email, in which case they MUST ignore - the contents of the *attachments* property (e.g. they MUST NOT - include a subset of attachments). + * "display": The alert should be displayed as appropriate for the + current device and user context. - An *UnknownAction* object is an object that contains a *type * - property whose value is not "email" or "string", plus zero or more - other properties. This is for compatibility with client - extensions and future RFCs. The client or server SHOULD NOT - trigger any type of alert for action types they do not understand, - but MUST preserve them. + * "email": The alert should trigger an email sent out to the + user, notifying about the alert. This action is typically only + appropriate for server implementations. 4.6. Multilingual properties 4.6.1. localizations - Type: "String[PatchObject]|null" + Type: "String[PatchObject]" (optional) - A map of [RFC5646] language tags to patch objects, which localise the + A map of [RFC5646] language tags to patch objects, which localize the calendar object into the locale of the respective language tag. See the description of PatchObject (Section 3.2.4) for the structure of the PatchObject. The patches are applied to the top-level object. In addition to all the restrictions on patches specified there, the pointer also MUST NOT start with one of the following prefixes; any patch with a such a key MUST be ignored: o @type @@ -1498,145 +1402,143 @@ 5.1.1. start Type: "LocalDate" e.g. "2015-09-02T00:00:00" The date/time the event would start in the event's time-zone. A valid JSEvent MUST include this property. 5.1.2. timeZone - Type: "String|null" + Type: "String|null" (optional, default:"null") - The IANA Time Zone Database [4] name for the time-zone the event is + The IANA Time Zone Database [3] name for the time-zone the event is scheduled in, or "null" for floating time. If omitted, this MUST be presumed to be "null" (i.e. floating time). 5.1.3. duration - Type: "Duration", e.g. "P2DT3H" (Defaults to "P0D" if omitted) + Type: "Duration", e.g. "P2DT3H" (optional, default: "P0D") The zero or positive duration of the event in absolute time (i.e. in UTC time; ignoring DST shifts). To get the end date in the event time-zone, convert start into UTC, then add the duration, then convert the result into the appropriate time-zone. A JSEvent MAY be end in a different time-zone (e.g. a plane flight crossing time-zones). In this case, the JSEvent MUST specify the end time-zone in a *location* property value that defines its *rel* to be "end" and the end time-zone in its *timeZone* property. 5.1.4. isAllDay - Type: "Boolean" (optional, defaults to "false") + Type: "Boolean" (optional, default:"false") Specifies if the event an all day event, such as a birthday or public holiday. If *isAllDay* is true, then the following restrictions apply: o the *start* property MUST have a time component of "T00:00:00". o the *duration* property MUST only include a day component. Note that all-day events MAY be bound to a specific time-zone, as defined by the *timeZone* property. 5.1.5. status - Type: "String" - - The scheduling status (Section 4.4) of a JSEvent defaults to - "confirmed" if omitted. + Type: "String" (optional, default:"confirmed") - If set, it MUST be one of: + The scheduling status (Section 4.4) of a JSEvent. If set, it MUST be + one of: o "confirmed": Indicates the event is definite. o "cancelled": Indicates the event is cancelled. o "tentative": Indicates the event is tentative. 5.2. JSTask properties In addition to the common JSCalendar object properties (Section 4) a JSTask has the following properties: 5.2.1. due - Type: "LocalDate|null" e.g. "2015-09-02T00:00:00" + Type: "LocalDate" (optional) e.g. "2015-09-02T00:00:00" The date/time the task is due in the task's time-zone. 5.2.2. start - Type: "LocalDate|null" e.g. "2015-09-02T00:00:00" + Type: "LocalDate" (optional) e.g. "2015-09-02T00:00:00" The date/time the task should start in the task's time-zone. 5.2.3. timeZone - Type: "String|null" + Type: "String|null" (optional, default:"null") The IANA Time Zone Database name for the time-zone the task is scheduled in, or "null" for floating time. If omitted, this MUST be presumed to be "null" (i.e. floating time). 5.2.4. estimatedDuration - Type: "Duration|null", e.g. "P2DT3H" + Type: "Duration" (optional), e.g. "P2DT3H" Specifies the estimated positive duration of time the task takes to complete. If the *start* and *due* properties are set, the estimated duration SHOULD be less than or equal to the time interval between these properties. 5.2.5. completed - Type: "UTCDate|null", e.g. "2016-06-13T12:00:00Z" + Type: "UTCDate" (optional), e.g. "2016-06-13T12:00:00Z" Specifies the date/time the task was completed. If the task is recurring and has future instances, a client may want to denote a specific task recurrence as completed but leave other instances as uncompleted. One way to achieve this is by overriding the completed property in the task *recurrenceOverrides*. However, this could produce a long list of completion times for regularly recurring tasks. An alternative approach is to split the JSTask into a current, single instance of JSTask with this instance completion time and a future recurring instance. Also see the definition of the *relatedTo* on splitting. 5.2.6. isAllDay - Type: "Boolean" (optional, defaults to "false") + Type: "Boolean" (optional, default:"false") Specifies if the task is an all day task. If *isAllDay* is true, then the *start* and *due* properties MUST have a time component of "T00:00:00". Note that the *estimatedDuration* property MAY contain a non-zero time duration. All-day tasks MAY be bound to a specific time-zone, as defined by the *timeZone* property. 5.2.7. progress In addition to the common properties of a *Participant* object (Section 4.4.5), a Participant within a JSTask supports the following property: - o *progress*: "ParticipantProgress|null" The progress of the - participant for this task, if known. This property MUST be "null" - if the *rsvpResponse* of this participant is any other value but - "accepted". + o *progress*: "ParticipantProgress" (optional) The progress of the + participant for this task, if known. This property MUST NOT be + set if the *rsvpResponse* of this participant is any other value + but "accepted". A *ParticipantProgress* object has the following properties: o *status*: "String" Describes the completion status of the participant's progress. The value MUST be at most one of the following values, registered in a future RFC, or a vendor-specific value: * "completed": The participant completed their progress. @@ -1650,40 +1552,39 @@ 5.2.8. status Type: "String" If omitted, the default scheduling status (Section 4.4) of a JSTask is defined as follows (in order of evaluation): o "needs-action": if the task has no participants, or if at least one participant of the task has *rsvpResponse* set to "needs- - action" (eiher explicitly or by default). + action" (either explicitly or by default). o "completed": if all the *ParticipantProgress* status of the task participants is "completed". o "failed": if at least one *ParticipantProgress* status of the task participants is "failed". o "in-process": if at least one *ParticipantProgress* status of the task participants is "in-process". o "pending": If none of the other criteria match. If set, it MUST be one of: o "needs-action": Indicates the task needs action. o "completed": Indicates the task is completed. If this value is - set, then the timestamp in the *completed* property MUST NOT be - null. + set, then the timestamp in the *completed* property MUST be set. o "in-process": Indicates the task is in process. o "cancelled": Indicates the task is cancelled. o "pending": Indicates the task has been created, but not yet started. o "failed": Indicates the task failed. @@ -1700,41 +1601,40 @@ o updated o categories o keywords o name o description - o htmlDescription - o color + o links as well as the following JSGroup-specific properties: 5.3.1. entries - Type: "(JSTask|JSEvent)[]|null" + Type: "String[JSTask|JSEvent]" - A list of group members. The list MAY contain multiple object types - and implementations MUST ignore entries of unknown type. The - property value MUST either be "null" or the list MUST NOT be empty. + A collection of group members. This is represented as a map of the + *uid* property value to the JSCalendar object member having that uid. + Implementations MUST ignore entries of unknown type. 5.3.2. source - Type: "String|null" (optional, default is "null") + Type: "String" (optional) The source from which updated versions of this group may be retrieved - from. If the value is not "null", it MUST be a URI. + from. The value MUST be a URI. 6. Conversion from and to iCalendar This section specifies which JSCalendar properties can be mapped from and to iCalendar format. Implementations SHOULD follow these conversion guidelines. Still, JSCalendar does not restrict itself to iCalendar and conversion between these two formats MAY be lossy. 6.1. JSEvent @@ -1797,35 +1697,33 @@ | | iCalendar. | | | | | timeZone | Corresponds to the TZID part of the | | | DTSTART/DUE properties in iCalendar. If the | | | task has a different end time-zone to start | | | or due time-zone, this should be added as a | | | JSCalendar *location* with just a *timeZone* | | | property and "rel="end"". | | | | | estimatedDuration | Corresponds to the ESTIMATED-DURATION | - | | iCalendar property. *NON-STANDARD*: this | - | | property is currently non-standard, see | + | | iCalendar property in the RFC draft | | | [draft-apthorp-ical-tasks]. | | | | | completed | Maps to the COMPLETED iCalendar property. | | | | | progress | Corresponds to the PARTSTAT and COMPLETED | | | properties in iCalendar, including the | - | | currently non-standard definitions in | + | | definitions in the RFC draft | | | [draft-apthorp-ical-tasks]. | | | | | status | Corresponds to the STATUS property in | - | | iCalendar, including the currently non- | - | | standard definitions in | - | | [draft-apthorp-ical-tasks]. | + | | iCalendar, including the definitions in the | + | | RFC draft [draft-apthorp-ical-tasks]. | +-------------------+-----------------------------------------------+ Table 3: Translation between JSTask and iCalendar 6.3. JSGroup A JSGroup converts to a iCalendar VCALENDAR containing VEVENT or VTODO components. +----------+--------------------------------------------------------+ @@ -1834,142 +1732,127 @@ | entries | The VEVENT and VTODO components within a top-level | | | VCALENDAR component. | | | | | source | Corresponds to the SOURCE property in iCalendar. | +----------+--------------------------------------------------------+ Table 4: Translation between JSGroup and iCalendar 6.4. Common properties - +---------------------+---------------------------------------------+ + +------------------------+------------------------------------------+ | Property | iCalendar counterpart | - +---------------------+---------------------------------------------+ + +------------------------+------------------------------------------+ | alerts | An *Alert* corresponds to the VALARM | - | | component in iCalendar, where the *action* | - | | is determined by the iCalendar ACTION | - | | property value (e.g., both "DISPLAY" and | - | | "AUDIO" actions map to a JSCalendar | - | | *DisplayAction* alert, and similarly for an | - | | iCalendar "EMAIL"). The *relativeTo* and | - | | *offset* properties corresponds to the | - | | iCalendar TRIGGER property. The | - | | *attachments* property of an *EmailAction* | - | | alert map to iCalendar ATTACH properties. | - | | For mapping *mediaLinks*, the iCalendar | - | | currently forbids to define ATTACH | - | | properties on VALARMs with DISPLAY action. | - | | Mapping this property is implementation- | - | | specific, but using "X-ATTACH" with the | - | | same semantics as ATTACH is a sane choice. | + | | component in iCalendar, where the | + | | *action* is determined by the iCalendar | + | | ACTION property value (e.g., both | + | | "DISPLAY" and "AUDIO" actions map to a | + | | JSCalendar *display* action, and | + | | similarly for "EMAIL"). The | + | | *relativeTo* and *offset* properties | + | | corresponds to the iCalendar TRIGGER | + | | property. | | | | - | categories | Corresponds to the STRUCTURED-CATEGORY | - | | property in iCalendar, see. *NON- | - | | STANDARD*: this property is currently non- | - | | standard, see | + | categories | Corresponds to the CONCEPT property in | + | | iCalendar, see in the RFC draft | | | [draft-ietf-calext-ical-relations]. | | | | | color | Corresponds to the COLOR property in | | | iCalendar, as specified in [RFC7986]. | | | | | created | Corresponds to the CREATED property in | | | iCalendar. | | | | - | description | Corresponds to the DESCRIPTION property in | - | | iCalendar. | + | description | Corresponds to the DESCRIPTION property | + | | and its ALTREP parameters in iCalendar. | | | | - | htmlDescription | Corresponds to the ALTREP parameter of the | - | | DESCRIPTION property (e.g. by setting | - | | ALTREP to a "data:text/html" URL containing | - | | the HTML text). Alternatively, use the | - | | STYLED-DESCRIPTION property. *NON- | - | | STANDARD*: the STYLED-DESCRIPTION property | - | | currently is non-standard, see | - | | [draft-ietf-calext-eventpub-extensions]. | + | descriptionContentType | Implementation-specific. | | | | | freeBusyStatus | Corresponds to the TRANSP property in | | | iCalendar. | | | | - | keywords | Corresponds to the CATEGORIES property in | - | | iCalendar, as specified in [RFC7986]. | + | keywords | Corresponds to the CATEGORIES property | + | | in iCalendar, as specified in [RFC7986]. | | | | | links | Corresponds to the ATTACH ([RFC5545]) or | | | IMAGE ([RFC7986]) properties with a URI | | | value type set to the link "href". | | | ([RFC7986]). The *type* property | - | | corresponds to the FMTTYPE parameter, the | - | | *size* property to the SIZE parameter. | - | | Mapping all other properties is | - | | implementation-specific. | + | | corresponds to the FMTTYPE parameter, | + | | the *size* property to the SIZE | + | | parameter. Mapping all other properties | + | | is implementation-specific. | | | | | locale | Corresponds to the LANGUAGE parameter in | | | iCalendar, which is added to individual | | | properties. When converting from | - | | iCalendar, one language must be picked as | - | | the main locale for the object, and all | - | | properties in other languages moved to the | - | | localizations JSEvent property. | + | | iCalendar, one language must be picked | + | | as the main locale for the object, and | + | | all properties in other languages moved | + | | to the localizations JSEvent property. | | | | | localizations | Implementation-specific. | | | | | locations | See Section 6.5. | | | | | method | Corresponds to the METHOD property in | | | iCalendar. | | | | | participants | See Section 6.5. | | | | | priority | Corresponds to the PRIORITY property in | | | iCalendar. | | | | | privacy | Corresponds to the CLASS property in | | | iCalendar. | | | | | prodId | Corresponds to the PRODID property in | | | iCalendar. | | | | | recurrenceOverrides | Corresponds to the RDATE and EXDATE | - | | properties in iCalendar, plus VEVENT (for | - | | JSEvent) or VTODO (for JSTask) instances | - | | with a recurrence-id. | + | | properties in iCalendar, plus VEVENT | + | | (for JSEvent) or VTODO (for JSTask) | + | | instances with a recurrence-id. | | | | | recurrenceRule | Corresponds to the RRULE property in | - | | iCalendar. See the property definition at | - | | section Section 4.3.1 how to map a RRULE | - | | value. | + | | iCalendar. See the property definition | + | | at section Section 4.3.1 how to map a | + | | RRULE value. | | | | - | relatedTo | Corresponds to the RELATED-TO property in | - | | iCalendar. | + | relatedTo | Corresponds to the RELATED-TO property | + | | in iCalendar. | | | | | replyTo | An iCalendar ORGANIZER with one of the | - | | mapped URIs as value. If URIs are defined | - | | for both the "imip" and "web" type, it is | - | | recommended to map the "imip" value to the | - | | calendar address value of the ORGANIZER. | + | | mapped URIs as value. If URIs are | + | | defined for both the "imip" and "web" | + | | type, it is recommended to map the | + | | "imip" value to the calendar address | + | | value of the ORGANIZER. | | | | | sequence | Corresponds to the SEQUENCE property in | | | iCalendar. | | | | | status | Corresponds to the STATUS property in | | | iCalendar (converted to lower-case). | | | | | title | Corresponds to the SUMMARY property in | | | iCalendar. | | | | | uid | Corresponds to the UID property in | | | iCalendar. | | | | | updated | Corresponds to the DTSTAMP and LAST- | | | MODIFIED properties in iCalendar. (These | | | are only different in the iTIP case, and | | | the difference is not actually useful.) | - +---------------------+---------------------------------------------+ + +------------------------+------------------------------------------+ Table 5: Translation between JSCalendar and iCalendar 6.5. Locations and participants Both JSCalendar participants and locations have counterparts in iCalendar but provide richer representation. The following table outlines translation of JSCalendar participants. Where iCalendar has distinct properties for ORGANIZER and ATTENDEE, @@ -2027,77 +1910,81 @@ | scheduleUpdated | the DTSTAMP | | | property of | | | the | | | participant's | | | latest iMIP | | | message | +--------------------------------------------------+----------------+ Table 6: Translation of Participant between JSCalendar and iCalendar - For JSCalendar locations, the iCalendar counterparts are the - [RFC5545] LOCATION and the extended iCalendar [RFC7986] CONFERENCE - properties. Generally, use a LOCATION property if only the name - property is set, CONFERENCE otherwise. For backwards compatibility - with client implementations that do not support the CONFERENCE - property, it is recommended to set use at least one LOCATION - property, if the JSCalendar object contains locations. + The iCalendar counterpart for JSCalendar Location objects is the + iCalendar [RFC5545] LOCATION property, or implementation-specific. +-------------+-----------------------------------------------------+ | Property | iCalendar counterpart | +-------------+-----------------------------------------------------+ - | name | For LOCATION: corresponds to the property value. | - | | For CONFERENCE: corresponds to the LABEL parameter. | + | name | Corresponds to the LOCATION property value. | | | | | description | Implementation-specific. | | | | - | rel | For CONFERENCE: implicitly "virtual". | - | | Implementation-specific for LOCATION. | - | | | - | features | For CONFERENCE: corresponds to the FEATURE | - | | parameter. Implementation-specific for LOCATION. | + | rel | Implementation-specific. | | | | | timeZone | Implementation-specific. | | | | | coordinates | Implementation-specific. Consider using a GEO | - | | iCalendar property, along with one LOCATION or | - | | CONFERENCE. | + | | iCalendar property, along with one LOCATION. | | | | - | uri | For LOCATION: corresponds to the ALTREP parameter. | - | | For CONFERENCE: corresponds to the property value. | + | uri | Corresponds to the LOCATION ALTREP parameter. | | | | | linkIds | Implementation-specific. | +-------------+-----------------------------------------------------+ Table 7: Translation of Location between JSCalendar and iCalendar + The iCalendar counterpart for JSCalendar VirtualLocation objects is + the iCalendar [RFC7986] CONFERENCE property, or implementation- + specific. + + +--------------+--------------------------------------------------+ + | Property | iCalendar counterpart | + +--------------+--------------------------------------------------+ + | name | Corresponds to the CONFERENCE LABEL parameter. | + | | | + | description | Implementation-specific. | + | | | + | uri | Corresponds to the CONFERENCE property value. | + +--------------+--------------------------------------------------+ + + Table 8: Translation of VirtualLocation between JSCalendar and + iCalendar + 6.6. Unknown properties Both JSCalendar and iCalendar calendar objects may contain properties that are not expressible in the other format. This specification does not mandate how to preserve these properties. Instead, it leaves negotiation on how to treat unknown properties to client and server implementations and their protocol used to exchange calendar objects. Two notable options to represent and preserve arbitrary iCalendar object properties in JSCalendar are: o *JCal*: Define iCalendar properties in JCal format ([RFC7265]) in a vendor-specific property of the JCalendar object. The JCal- formatted value may either only contain iCalendar properties that were not mapped to JSCalendar properties, or contain the complete iCalendar object representation. - o *Alternate link*: Define an alternate link (Section 4.2.5) value + o *Alternate link*: Define an alternate link (Section 4.2.6) value pointing to the iCalendar representation of the JSCalendar object. - E.g. the alternative representation of a VEVENT would be represented as a link with rel "alternate" and type "text/ calendar;component=VEVENT". 7. JSCalendar object examples The following examples illustrate several aspects of the JSCalendar data model and format. The examples may omit mandatory or additional properties, which is indicated by a placeholder property with key "...". While most of the examples use calendar event objects, they @@ -2232,51 +2119,46 @@ } 7.8. Event with multiple locations and localization This example illustrates an event that happens at both a physical and a virtual location. Fans can see a live convert on premises or online. The event title and descriptions are localized. (Note: the localization of the event description contains an UTF-8 encoded German Umlaut. This character may have been replaced with ASCII characters in the plain-text rendering of this RFC document) - { "...": "", "title": "Live from Music Bowl: The Band", "description": "Go see the biggest music event ever!", "locale": "en", "start": "2018-07-04T17:00:00", "timeZone": "America/New_York", "duration": "PT3H", "locations": { - "9366e041-bb4c-4aa4-b249-b4657cab925c": { + "c0503d30-8c50-4372-87b5-7657e8e0fedd": { "name": "The Music Bowl", "description": "Music Bowl, Central Park, New York", "coordinates": "geo:40.7829,73.9654" + } }, + "virtualLocations": { "6f3696c6-1e07-47d0-9ce1-f50014b0041a": { "name": "Free live Stream from Music Bowl", - "rel": "virtual", - "features": [ - "video", - "audio", - "chat" - ], "uri": "https://stream.example.com/the_band_2018" } }, "localizations": { "de": { "title": "Live von der Music Bowl: The Band!", "description": "Schau dir das groesste Musikereignis an!", - "locations/6f3696c6-1e07-47d0-9ce1-f50014b0041a/name": + "virtualLocations/6f3696c6-1e07-47d0-9ce1-f50014b0041a/name": "Gratis Live-Stream aus der Music Bowl" } } } 7.9. Recurring event with overrides This example illustrates the use of recurrence overrides. A math course at a University is held for the first time on January 8, 2018 at 9am London time and occurs every week until June 25, 2018. Each @@ -2416,26 +2298,20 @@ 11. References 11.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . - [RFC2183] Troost, R., Dorner, S., and K. Moore, Ed., "Communicating - Presentation Information in Internet Messages: The - Content-Disposition Header Field", RFC 2183, - DOI 10.17487/RFC2183, August 1997, - . - [RFC2392] Levinson, E., "Content-ID and Message-ID Uniform Resource Locators", RFC 2392, DOI 10.17487/RFC2392, August 1998, . [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, . [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, @@ -2521,40 +2397,36 @@ [RFC8288] Nottingham, M., "Web Linking", RFC 8288, DOI 10.17487/RFC8288, October 2017, . 11.2. Informative References [draft-apthorp-ical-tasks] "Task Extensions to iCalendar", . - [draft-ietf-calext-eventpub-extensions] - "Event Publishing Extensions to iCalendar", - . - [draft-ietf-calext-ical-relations] "Support for iCalendar Relationships", . -11.3. URIs + [MIME] "IANA Media Types", . - [1] https://www.w3.org/TR/html/ +11.3. URIs - [2] https://www.iana.org/assignments/link-relations/link- + [1] https://www.iana.org/assignments/link-relations/link- relations.xhtml - [3] https://www.w3.org/TR/2011/REC-css3-color-20110607/#svg-color + [2] https://www.w3.org/TR/2011/REC-css3-color-20110607/#svg-color - [4] http://www.iana.org/time-zones + [3] http://www.iana.org/time-zones Authors' Addresses Neil Jenkins FastMail PO Box 234 Collins St West Melbourne VIC 8007 Australia