idnits 2.17.1 draft-ietf-calext-jscalendar-10.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (November 22, 2018) is 1975 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Looks like a reference, but probably isn't: '1' on line 2501 -- Looks like a reference, but probably isn't: '2' on line 2504 -- Looks like a reference, but probably isn't: '3' on line 2506 Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Calendaring extensions N. Jenkins 3 Internet-Draft R. Stepanek 4 Intended status: Standards Track FastMail 5 Expires: May 26, 2019 November 22, 2018 7 JSCalendar: A JSON representation of calendar data 8 draft-ietf-calext-jscalendar-10 10 Abstract 12 This specification defines a data model and JSON representation of 13 calendar data that can be used for storage and data exchange in a 14 calendaring and scheduling environment. It aims to be an alternative 15 to the widely deployed iCalendar data format and to be unambiguous, 16 extendable and simple to process. 18 Status of This Memo 20 This Internet-Draft is submitted in full conformance with the 21 provisions of BCP 78 and BCP 79. 23 Internet-Drafts are working documents of the Internet Engineering 24 Task Force (IETF). Note that other groups may also distribute 25 working documents as Internet-Drafts. The list of current Internet- 26 Drafts is at https://datatracker.ietf.org/drafts/current/. 28 Internet-Drafts are draft documents valid for a maximum of six months 29 and may be updated, replaced, or obsoleted by other documents at any 30 time. It is inappropriate to use Internet-Drafts as reference 31 material or to cite them other than as "work in progress." 33 This Internet-Draft will expire on May 26, 2019. 35 Copyright Notice 37 Copyright (c) 2018 IETF Trust and the persons identified as the 38 document authors. All rights reserved. 40 This document is subject to BCP 78 and the IETF Trust's Legal 41 Provisions Relating to IETF Documents 42 (https://trustee.ietf.org/license-info) in effect on the date of 43 publication of this document. Please review these documents 44 carefully, as they describe your rights and restrictions with respect 45 to this document. Code Components extracted from this document must 46 include Simplified BSD License text as described in Section 4.e of 47 the Trust Legal Provisions and are provided without warranty as 48 described in the Simplified BSD License. 50 Table of Contents 52 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 53 1.1. Relation to the iCalendar format . . . . . . . . . . . . 4 54 1.2. Notational Conventions . . . . . . . . . . . . . . . . . 5 55 2. JSCalendar objects . . . . . . . . . . . . . . . . . . . . . 5 56 2.1. JSEvent . . . . . . . . . . . . . . . . . . . . . . . . . 5 57 2.2. JSTask . . . . . . . . . . . . . . . . . . . . . . . . . 6 58 2.3. JSGroup . . . . . . . . . . . . . . . . . . . . . . . . . 6 59 3. Structure of JSCalendar objects . . . . . . . . . . . . . . . 6 60 3.1. Type signatures . . . . . . . . . . . . . . . . . . . . . 6 61 3.2. Data Types . . . . . . . . . . . . . . . . . . . . . . . 7 62 3.2.1. UTCDate . . . . . . . . . . . . . . . . . . . . . . . 7 63 3.2.2. LocalDate . . . . . . . . . . . . . . . . . . . . . . 7 64 3.2.3. Duration . . . . . . . . . . . . . . . . . . . . . . 7 65 3.2.4. PatchObject . . . . . . . . . . . . . . . . . . . . . 8 66 3.2.5. Identifiers . . . . . . . . . . . . . . . . . . . . . 8 67 3.2.6. Normalization and equivalence . . . . . . . . . . . . 9 68 3.3. Custom property extensions and values . . . . . . . . . . 9 69 4. Common JSCalendar properties . . . . . . . . . . . . . . . . 9 70 4.1. Metadata properties . . . . . . . . . . . . . . . . . . . 10 71 4.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 10 72 4.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 10 73 4.1.3. relatedTo . . . . . . . . . . . . . . . . . . . . . . 10 74 4.1.4. prodId . . . . . . . . . . . . . . . . . . . . . . . 11 75 4.1.5. created . . . . . . . . . . . . . . . . . . . . . . . 12 76 4.1.6. updated . . . . . . . . . . . . . . . . . . . . . . . 12 77 4.1.7. sequence . . . . . . . . . . . . . . . . . . . . . . 12 78 4.1.8. method . . . . . . . . . . . . . . . . . . . . . . . 12 79 4.2. What and where properties . . . . . . . . . . . . . . . . 12 80 4.2.1. title . . . . . . . . . . . . . . . . . . . . . . . . 12 81 4.2.2. description . . . . . . . . . . . . . . . . . . . . . 12 82 4.2.3. descriptionContentType . . . . . . . . . . . . . . . 12 83 4.2.4. locations . . . . . . . . . . . . . . . . . . . . . . 13 84 4.2.5. virtualLocations . . . . . . . . . . . . . . . . . . 14 85 4.2.6. links . . . . . . . . . . . . . . . . . . . . . . . . 14 86 4.2.7. locale . . . . . . . . . . . . . . . . . . . . . . . 15 87 4.2.8. keywords . . . . . . . . . . . . . . . . . . . . . . 16 88 4.2.9. categories . . . . . . . . . . . . . . . . . . . . . 16 89 4.2.10. color . . . . . . . . . . . . . . . . . . . . . . . . 16 90 4.3. Recurrence properties . . . . . . . . . . . . . . . . . . 16 91 4.3.1. recurrenceRule . . . . . . . . . . . . . . . . . . . 16 92 4.3.2. recurrenceOverrides . . . . . . . . . . . . . . . . . 22 93 4.3.3. excluded . . . . . . . . . . . . . . . . . . . . . . 23 94 4.4. Sharing and scheduling properties . . . . . . . . . . . . 23 95 4.4.1. priority . . . . . . . . . . . . . . . . . . . . . . 23 96 4.4.2. freeBusyStatus . . . . . . . . . . . . . . . . . . . 24 97 4.4.3. privacy . . . . . . . . . . . . . . . . . . . . . . . 24 98 4.4.4. replyTo . . . . . . . . . . . . . . . . . . . . . . . 25 99 4.4.5. participants . . . . . . . . . . . . . . . . . . . . 25 100 4.5. Alerts properties . . . . . . . . . . . . . . . . . . . . 29 101 4.5.1. useDefaultAlerts . . . . . . . . . . . . . . . . . . 29 102 4.5.2. alerts . . . . . . . . . . . . . . . . . . . . . . . 29 103 4.6. Multilingual properties . . . . . . . . . . . . . . . . . 30 104 4.6.1. localizations . . . . . . . . . . . . . . . . . . . . 30 105 5. Type-specific JSCalendar properties . . . . . . . . . . . . . 31 106 5.1. JSEvent properties . . . . . . . . . . . . . . . . . . . 32 107 5.1.1. start . . . . . . . . . . . . . . . . . . . . . . . . 32 108 5.1.2. timeZone . . . . . . . . . . . . . . . . . . . . . . 32 109 5.1.3. duration . . . . . . . . . . . . . . . . . . . . . . 32 110 5.1.4. isAllDay . . . . . . . . . . . . . . . . . . . . . . 32 111 5.1.5. status . . . . . . . . . . . . . . . . . . . . . . . 33 112 5.2. JSTask properties . . . . . . . . . . . . . . . . . . . . 33 113 5.2.1. due . . . . . . . . . . . . . . . . . . . . . . . . . 33 114 5.2.2. start . . . . . . . . . . . . . . . . . . . . . . . . 33 115 5.2.3. timeZone . . . . . . . . . . . . . . . . . . . . . . 33 116 5.2.4. estimatedDuration . . . . . . . . . . . . . . . . . . 34 117 5.2.5. statusUpdatedAt . . . . . . . . . . . . . . . . . . . 34 118 5.2.6. isAllDay . . . . . . . . . . . . . . . . . . . . . . 34 119 5.2.7. progress . . . . . . . . . . . . . . . . . . . . . . 34 120 5.2.8. status . . . . . . . . . . . . . . . . . . . . . . . 35 121 5.3. JSGroup properties . . . . . . . . . . . . . . . . . . . 36 122 5.3.1. entries . . . . . . . . . . . . . . . . . . . . . . . 36 123 5.3.2. source . . . . . . . . . . . . . . . . . . . . . . . 36 124 6. Conversion from and to iCalendar . . . . . . . . . . . . . . 36 125 6.1. JSEvent . . . . . . . . . . . . . . . . . . . . . . . . . 37 126 6.2. JSTask . . . . . . . . . . . . . . . . . . . . . . . . . 37 127 6.3. JSGroup . . . . . . . . . . . . . . . . . . . . . . . . . 39 128 6.4. Common properties . . . . . . . . . . . . . . . . . . . . 39 129 6.5. Locations and participants . . . . . . . . . . . . . . . 41 130 6.6. Unknown properties . . . . . . . . . . . . . . . . . . . 44 131 7. JSCalendar object examples . . . . . . . . . . . . . . . . . 44 132 7.1. Simple event . . . . . . . . . . . . . . . . . . . . . . 44 133 7.2. Simple task . . . . . . . . . . . . . . . . . . . . . . . 45 134 7.3. Simple group . . . . . . . . . . . . . . . . . . . . . . 45 135 7.4. All-day event . . . . . . . . . . . . . . . . . . . . . . 45 136 7.5. Task with a due date . . . . . . . . . . . . . . . . . . 46 137 7.6. Event with end time-zone . . . . . . . . . . . . . . . . 46 138 7.7. Floating-time event (with recurrence) . . . . . . . . . . 47 139 7.8. Event with multiple locations and localization . . . . . 47 140 7.9. Recurring event with overrides . . . . . . . . . . . . . 48 141 7.10. Recurring event with participants . . . . . . . . . . . . 49 142 8. Security Considerations . . . . . . . . . . . . . . . . . . . 51 143 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 51 144 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 51 145 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 51 146 11.1. Normative References . . . . . . . . . . . . . . . . . . 51 147 11.2. Informative References . . . . . . . . . . . . . . . . . 53 148 11.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 54 149 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 54 151 1. Introduction 153 This document defines a data model for calendar event and task 154 objects, or groups of such objects, in electronic calendar 155 applications and systems. It aims to be unambiguous, extendable and 156 simple to process. 158 The key design considerations for this data model are as follows: 160 o The attributes of the calendar entry represented must be described 161 as a simple key-value pair, reducing complexity of its 162 representation. 164 o The data model should avoid all ambiguities and make it difficult 165 to make mistakes during implementation. 167 o Most of the initial set of attributes should be taken from the 168 iCalendar data format ([RFC5545], also see Section 1.1), but the 169 specification should add new attributes or value types, or not 170 support existing ones, where appropriate. Conversion between the 171 data formats need not fully preserve semantic meaning. 173 o Extensions, such as new properties and components, MUST NOT lead 174 to requiring an update to this document. 176 The representation of this data model is defined in the I-JSON format 177 [RFC7493], which is a strict subset of the JavaScript Object Notation 178 (JSON) Data Interchange Format [RFC8259]. Using JSON is mostly a 179 pragmatic choice: its widespread use makes JSCalendar easier to 180 adopt, and the ready availability of production-ready JSON 181 implementations eliminates a whole category of parser-related 182 interoperability issues. 184 1.1. Relation to the iCalendar format 186 The iCalendar data format [RFC5545], a widely deployed interchange 187 format for calendaring and scheduling data, has served calendaring 188 vendors for a long while, but contains some ambiguities and pitfalls 189 that can not be overcome without backward-incompatible changes. 191 For example, iCalendar defines various formats for local times, UTC 192 time and dates, which confuses new users. Other sources for errors 193 are the requirement for custom time zone definitions within a single 194 calendar component, as well as the iCalendar format itself; the 195 latter causing interoperability issues due to misuse of CR LF 196 terminated strings, line continuations and subtle differences between 197 iCalendar parsers. Lastly, up until recently the iCalendar format 198 did not have a way to express a concise difference between two 199 calendar components, which results in verbose exchanges during 200 scheduling. 202 Some of these issues were addressed by the jCal [RFC7265] format, 203 which is a direct mapping between iCalendar and JSON. However, it 204 did not attempt to extend or update iCalendar semantics. 206 1.2. Notational Conventions 208 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 209 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 210 document are to be interpreted as described in [RFC2119]. 212 The underlying format used for this specification is JSON. 213 Consequently, the terms "object" and "array" as well as the four 214 primitive types (strings, numbers, booleans, and null) are to be 215 interpreted as described in Section 1 of [RFC8259]. 217 Some examples in this document contain "partial" JSON documents used 218 for illustrative purposes. In these examples, three periods "..." 219 are used to indicate a portion of the document that has been removed 220 for compactness. In this document, property and object definitions 221 are formatted like *this* and are referred to in other sections like 222 _this_. Verbatim text is formatted like "this". 224 2. JSCalendar objects 226 This section describes the calendar object types specified by 227 JSCalendar. 229 2.1. JSEvent 231 MIME type: "application/calendar+json;type=jsevent" 233 A JSEvent represents a scheduled amount of time on a calendar, 234 typically a meeting, appointment, reminder or anniversary. Multiple 235 participants may partake in the event at multiple locations. 237 The @type (Section 4.1.1) property value MUST be "jsevent". 239 2.2. JSTask 241 MIME type: "application/calendar+json;type=jstask" 243 A JSTask represents an action-item, assignment, to-do or work item . 245 The @type (Section 4.1.1) property value MUST be "jstask". 247 A JSTask may start and be due at certain points in time, may take 248 some estimated time to complete and may recur; none of which is 249 required. This notably differs from JSEvent (Section 2.1) which is 250 required to start at a certain point in time and typically takes some 251 non-zero duration to complete. 253 2.3. JSGroup 255 MIME type: "application/calendar+json;type=jsgroup" 257 A JSGroup is a collection of JSEvent (Section 2.1) and JSTask 258 (Section 2.2) objects. Typically, objects are grouped by topic (e.g. 259 by keywords) or calendar membership. 261 The @type (Section 4.1.1) property value MUST be "jsgroup". 263 3. Structure of JSCalendar objects 265 A JSCalendar object is a JSON object, which MUST be valid I-JSON (a 266 stricter subset of JSON), as specified in [RFC8259]. Property names 267 and values are case-sensitive. 269 The object has a collection of properties, as specified in the 270 following sections. Unless otherwise specified, all properties are 271 mandatory. Optional properties may have a default value, if 272 explicitly specified in the property definition. 274 3.1. Type signatures 276 Types signatures are given for all JSON objects in this document. 277 The following conventions are used: 279 o "Boolean|String": The value is either a JSON "Boolean" value, or a 280 JSON "String" value. 282 o "Foo": Any name that is not a native JSON type means an object for 283 which the properties (and their types) are defined elsewhere 284 within this document. 286 o "Foo[]": An array of objects of type "Foo". 288 o "String[Foo]": A JSON "Object" being used as a map (associative 289 array), where all the values are of type "Foo". 291 3.2. Data Types 293 In addition to the standard JSON data types, the following data types 294 are used in this specification: 296 3.2.1. UTCDate 298 This is a string in [RFC3339] "date-time" format, with the further 299 restrictions that any letters MUST be in upper-case, the time 300 component MUST be included and the time MUST be in UTC. Fractional 301 second values MUST NOT be included unless non-zero and MUST NOT have 302 trailing zeros, to ensure there is only a single representation for 303 each date-time. 305 For example "2010-10-10T10:10:10.003Z" is OK, but 306 "2010-10-10T10:10:10.000Z" is invalid and MUST be encoded as 307 "2010-10-10T10:10:10Z". 309 In common notation, it should be of the form "YYYY-MM-DDTHH:MM:SSZ". 311 3.2.2. LocalDate 313 This is a date-time string _with no time zone/offset information_. 314 It is otherwise in the same format as UTCDate: "YYYY-MM-DDTHH:MM:SS". 315 The time zone to associate the LocalDate with comes from an 316 associated property, or if no time zone is associated it defines 317 _floating time_. Floating date-times are not tied to any specific 318 time zone. Instead, they occur in every timezone at the same _wall- 319 clock_ time (as opposed to the same instant point in time). 321 3.2.3. Duration 323 A duration is represented by a subset of ISO8601 duration format, as 324 specified by the following ABNF: 326 dur-secfrac = "." 1*DIGIT 327 dur-second = 1*DIGIT [dur-secfrac] "S" 328 dur-minute = 1*DIGIT "M" [dur-second] 329 dur-hour = 1*DIGIT "H" [dur-minute] 330 dur-time = "T" (dur-hour / dur-minute / dur-second) 331 dur-day = 1*DIGIT "D" 332 dur-week = 1*DIGIT "W" 334 duration = "P" (dur-day [dur-time] / dur-time / dur-week) 336 In addition, the duration MUST NOT include fractional second values 337 unless the fraction is non-zero. 339 3.2.4. PatchObject 341 A *PatchObject* is of type "String[*|null]", and represents an 342 unordered set of patches on a JSON object. The keys are a path in a 343 subset of [RFC6901] JSON pointer format, with an implicit leading "/" 344 (i.e. prefix each key with "/" before applying the JSON pointer 345 evaluation algorithm). 347 A patch within a PatchObject is only valid, if all of the following 348 conditions apply: 350 1. The pointer MUST NOT reference inside an array (i.e. it MUST NOT 351 insert/delete from an array; the array MUST be replaced in its 352 entirety instead). 354 2. When evaluating a path, all parts prior to the last (i.e. the 355 value after the final slash) MUST exist. 357 3. There MUST NOT be two patches in the PatchObject where the 358 pointer of one is the prefix of the pointer of the other, e.g. 359 "alerts/foo/offset" and "alerts". 361 The value associated with each pointer is either: 363 o "null": Remove the property from the patched object. If not 364 present in the parent, this a no-op. 366 o Anything else: The value to replace the inherited property on the 367 patch object with (if present) or add to the property (if not 368 present). 370 Implementations MUST reject a PatchObject if any of its patches are 371 invalid. 373 3.2.5. Identifiers 375 If not noted otherwise, properties and object keys that define 376 identifiers MUST be string values, MUST be at least 1 character and 377 maximum 256 characters in size, and MUST only contain characters from 378 the "URL and Filename safe" Base 64 Alphabet, as defined in section 5 379 of [RFC4648]. This is the ASCII alphanumeric characters (A-Za-z0-9), 380 hyphen (-), and underscore (_). Note that [RFC7493] requires string 381 values be encoded in UTF-8, so the maximum size of an identifier 382 according to this definition is 256 octets. 384 3.2.6. Normalization and equivalence 386 JSCalendar aims to provide unambiguous definitions for value types 387 and properties, but does not define a general normalization or 388 equivalence method for JSCalendar objects and types. This is because 389 the notion of equivalence might range from byte-level equivalence to 390 semantic equivalence, depending on the respective use case (for 391 example, the CalDAV protocol [RFC4791] requires octet equivalence of 392 the encoded calendar object to determine ETag equivalence). 394 Normalization of JSCalendar objects is hindered because of the 395 following reasons: 397 o Custom JSCalendar properties may contain arbitrary JSON values, 398 including arrays. However, equivalence of arrays might or might 399 not depend on the order of elements, depending on the respective 400 property definition. 402 o Several JSCalendar property values are defined as URIs and MIME 403 types, but normalization of these types is inherently protocol and 404 scheme-specific, depending on the use-case of the equivalence 405 definition (see section 6 of [RFC3986]). 407 Considering this, the definition of equivalence and normalization is 408 left to client and server implementations and to be negotiated by a 409 calendar exchange protocol or defined by another RFC. 411 3.3. Custom property extensions and values 413 Vendors MAY add additional properties to the calendar object to 414 support their custom features. The names of these properties MUST be 415 prefixed with a domain name controlled by the vendor to avoid 416 conflict, e.g. "example.com/customprop". 418 Some JSCalendar properties allow vendor-specific value extensions. 419 If so, vendor specific values MUST be prefixed with a domain name 420 controlled by the vendor, e.g. "example.com/customrel", unless 421 otherwise noted. 423 4. Common JSCalendar properties 425 This section describes the properties that are common to the various 426 JSCalendar object types. Specific JSCalendar object types may only 427 support a subset of these properties. The object type definitions in 428 Section 5 describe the set of supported properties per type. 430 4.1. Metadata properties 432 4.1.1. @type 434 Type: "String" 436 Specifies the type which this object represents. This MUST be one of 437 the following values, registered in a future RFC, or a vendor- 438 specific value: 440 o "jsevent": a JSCalendar event (Section 2.1). 442 o "jstask": a JSCalendar task (Section 2.2). 444 o "jsgroup": a JSCalendar group (Section 2.3). 446 A valid JSCalendar object MUST include this property. 448 4.1.2. uid 450 Type: "String" 452 A globally unique identifier, used to associate the object as the 453 same across different systems, calendars and views. The value of 454 this property MUST be unique across _all_ JSCalendar objects, even if 455 they are of different type. [RFC4122] describes a range of 456 established algorithms to generate universally unique identifiers 457 (UUID), and the random or pseudo-random version is recommended. 459 For compatibility with [RFC5545] UIDs, implementations MUST be able 460 to receive and persist values of at least 255 octets for this 461 property, but they MUST NOT truncate values in the middle of a UTF-8 462 multi-octet sequence. 464 A valid JSCalendar object MUST include this property. 466 4.1.3. relatedTo 468 Type: "String[Relation]" (optional) 470 Relates the object to other JSCalendar objects. This is represented 471 as a map of the UIDs of the related objects to information about the 472 relation. 474 A *Relation* object has the following properties: 476 o *relation*: "String[Boolean]" (optional) Describes how the linked 477 object is related to this object as a set of relation types. If 478 not null, the set MUST NOT be empty. 480 Keys in the set MUST be one of the following values, defined in a 481 future specification or a vendor-specific value: 483 * "first": The linked object is the first in the series this 484 object is part of. 486 * "next": The linked object is the next in the series this object 487 is part of. 489 * "child": The linked object is a subpart of this object. 491 * "parent": This object is part of the overall linked object. 493 The value for each key in the set MUST be "true". 495 If an object is split to make a "this and future" change to a 496 recurrence, the original object MUST be truncated to end at the 497 previous occurrence before this split, and a new object created to 498 represent all the objects after the split. A "next" relation MUST be 499 set on the original object's relatedTo property for the UID of the 500 new object. A "first" relation for the UID of the first object in 501 the series MUST be set on the new object. Clients can then follow 502 these UIDs to get the complete set of objects if the user wishes to 503 modify them all at once. 505 4.1.4. prodId 507 Type: "String" (optional) 509 The identifier for the product that created the JSCalendar object. 511 The vendor of the implementation SHOULD ensure that this is a 512 globally unique identifier, using some technique such as an FPI 513 value, as defined in [ISO.9070.1991]. It MUST only use characters of 514 an iCalendar TEXT data value (see section 3.3.11 in [RFC5545]). 516 This property SHOULD NOT be used to alter the interpretation of an 517 JSCalendar object beyond the semantics specified in this document. 518 For example, it is not to be used to further the understanding of 519 non-standard properties. 521 4.1.5. created 523 Type: "UTCDate" (optional) 525 The date and time this object was initially created. 527 4.1.6. updated 529 Type: "UTCDate" 531 The date and time the data in this object was last modified. 533 4.1.7. sequence 535 Type: "Number" (optional, default:"0") 537 Initially zero, this MUST be a non-negative integer that is 538 monotonically incremented each time a change is made to the object. 540 4.1.8. method 542 Type: "String" (optional) 544 The iTIP ([RFC5546]) method, in lower-case. Used for scheduling. 546 4.2. What and where properties 548 4.2.1. title 550 Type: "String" (optional, default:"") 552 A short summary of the object. 554 4.2.2. description 556 Type: "String" (optional, default:"") 558 A longer-form text description of the object. The content is 559 formatted according to the _descriptionContentType_ property. 561 4.2.3. descriptionContentType 563 Type: "String" (optional, default:"text/plain") 565 Describes the media type ([RFC6838]) of the contents of the 566 "description" property. Media types MUST be sub-types of type 567 "text", and SHOULD be "text/plain" or "text/html" ([MIME]). They MAY 568 define parameters and the "charset" parameter MUST be "utf-8", if 569 specified. Descriptions of type "text/html" MAY contain "cid" URLs 570 ([RFC2392]) to reference links in the calendar object by use of the 571 _cid_ property of the _Link_ object. 573 4.2.4. locations 575 Type: "String[Location]" (optional) 577 A map of location ids to Location objects, representing locations 578 associated with the object. A location id MUST be unique to this 579 object; a UUID is a practical choice. 581 A *Location* object has the following properties. It must define at 582 least one other property than _rel_. 584 o *name*: "String" (optional, default:"") The human-readable name of 585 the location. 587 o *description*: "String" (optional) Human-readable, plain-text 588 instructions for accessing this location. This may be an address, 589 set of directions, door access code, etc. 591 o *rel*: "String" (optional) The relation type of this location to 592 the JSCalendar object. 594 This MUST be either one of the following values, registered in a 595 future RFC, or a vendor-specific value. Any value the client or 596 server doesn't understand should be treated the same as if this 597 property is omitted. 599 * "start": The JSCalendar object starts at this location. 601 * "end": The JSCalendar object ends at this location. 603 o *timeZone*: "String" (optional) A time zone for this location. 605 o *coordinates*: "String" (optional) An [RFC5870] "geo:" URI for the 606 location. 608 o *linkIds*: "String[Boolean]" (optional) A set of link ids for 609 links to alternate representations of this location. Each key in 610 the set MUST be the identifier of a Link object defined in the 611 _links_ property of this calendar object. The value for each key 612 in the set MUST be "true". This MUST be omitted if none (rather 613 than an empty set). 615 For example, an alternative representation could be in vCard 616 format. 618 4.2.5. virtualLocations 620 Type: "String[VirtualLocation]" (optional) 622 A map of ids to VirtualLocation objects, representing virtual 623 locations, such as video conferences or chat rooms, associated with 624 the object. A virtual location id MUST be unique to this object; a 625 UUID is a practical choice. 627 A *VirtualLocation* object has the following properties. 629 o *name*: "String" (optional, default:"") The human-readable name of 630 the virtual location. 632 o *description*: "String" (optional) Human-readable plain-text 633 instructions for accessing this location. This may be an address, 634 set of directions, door access code, etc. 636 o *uri*: "String" A URI that represents how to connect to this 637 virtual location. 639 This may be a telephone number (represented as 640 "tel:+1-555-555-555") for a teleconference, a web address for 641 online chat, or any custom URI. 643 4.2.6. links 645 Type: "String[Link]" (optional) 647 A map of link ids to Link objects, representing external resources 648 associated with the object. A link id MUST be unique to this 649 calendar object; a UUID is a practical choice. 651 A *Link* object has the following properties: 653 o *href*: "String" A URI from which the resource may be fetched. 655 This MAY be a "data:" URL, but it is recommended that the file be 656 hosted on a server to avoid embedding arbitrarily large data in 657 JSCalendar object instances. 659 o *cid* "String" (optional) This MUST be a valid "content-id" value 660 according to the definition of section 2 in [RFC2392]. The 661 identifier MUST be unique within this JSCalendar object but has no 662 meaning beyond that. Specifically, it MAY be different from the 663 link identifier in the enclosing _links_ property. 665 o *type*: "String" (optional) The content-type [RFC6838] of the 666 resource, if known. 668 o *size*: "Number" (optional) The size, in bytes, of the resource 669 when fully decoded (i.e. the number of bytes in the file the user 670 would download), if known. 672 o *rel*: "String" (optional, default:"enclosure") Identifies the 673 relation of the linked resource to the object. If set, the value 674 MUST be a registered relation type (see [RFC8288] and IANA Link 675 Relations [1]). 677 Links with a rel of "enclosure" SHOULD be considered by the client 678 as attachments for download. 680 Links with a rel of "describedby" SHOULD be considered by the 681 client to be an alternate representation of the description. 683 Links with a rel of "icon" SHOULD be considered by the client to 684 be an image that it MAY use when presenting the calendar data to a 685 user. The _display_ property MAY be set to indicate the purpose 686 of this image. 688 o *display*: "String" (optional) Describes the intended purpose of a 689 link to an image. If set, the _rel_ property MUST be set to 690 "icon". The value MUST be either one of the following values, 691 registered in a future RFC, or a vendor-specific value: 693 * "badge": an image inline with the title of the object 695 * "graphic": a full image replacement for the object itself 697 * "fullsize": an image that is used to enhance the object 699 * "thumbnail": a smaller variant of "fullsize " to be used when 700 space for the image is constrained 702 o *title*: "String" (optional) A human-readable plain-text 703 description of the resource. 705 4.2.7. locale 707 Type: "String" (optional) 709 The [RFC5646] language tag that best describes the locale used for 710 the calendar object, if known. 712 4.2.8. keywords 714 Type: "String[Boolean]" (optional) 716 A set of keywords or tags that relate to the object. The set is 717 represented as a map, with the keys being the keywords. The value 718 for each key in the map MUST be "true". 720 4.2.9. categories 722 Type: "String[Boolean]" (optional) 724 A set of categories that relate to the calendar object. The set is 725 represented as a map, with the keys being the categories specified as 726 URIs. The value for each key in the map MUST be "true". 728 In contrast to _keywords_, categories typically are structured. For 729 example, a vendor owning the domain "example.com" might define the 730 categories "http://example.com/categories/sports/american-football"" 731 and "http://example.com/categories/music/r-b". 733 4.2.10. color 735 Type: "String" (optional) 737 Specifies a color clients MAY use when displaying this calendar 738 object. The value is a case-insensitive color name taken from the 739 CSS3 set of names, defined in Section 4.3 of W3C.REC- 740 css3-color-20110607 [2] or a CSS3 RGB color hex value. 742 4.3. Recurrence properties 744 4.3.1. recurrenceRule 746 Type: "Recurrence" 748 Defines a recurrence rule (repeating pattern) for recurring calendar 749 objects. 751 A *Recurrence* object is a JSON object mapping of a RECUR value type 752 in iCalendar, see [RFC5545] and[RFC7529]. A JSEvent recurs by 753 applying the recurrence rule (and _recurrenceOverrides_) to the 754 _start_ date/time. A JSTask recurs by applying the recurrence rule 755 (and _recurrenceOverrides_) to its _start_ date/time, if defined. If 756 the task does not define a start date-time, it recurs by its _due_ 757 date-time. If it neither defines a start or due date-time, it MUST 758 NOT define a _recurrenceRule_. 760 A Recurrence object has the following properties: 762 o *frequency*: "String" This MUST be one of the following values: 764 * "yearly" 766 * "monthly" 768 * "weekly" 770 * "daily" 772 * "hourly" 774 * "minutely" 776 * "secondly" 778 To convert from iCalendar, simply lower-case the FREQ part. 780 o *interval*: "Number" (optional, default:"1") The INTERVAL part 781 from iCal. If included, it MUST be an integer "x >= 1". 783 o *rscale*: "String" (optional, default:""gregorian"") The RSCALE 784 part from iCalendar RSCALE [RFC7529], converted to lower-case. 786 o *skip*: "String" (optional, default:""omit"") The SKIP part from 787 iCalendar RSCALE [RFC7529], converted to lower-case. 789 o *firstDayOfWeek*: "String" (optional, default:""mo"") The WKST 790 part from iCalendar, represented as a lower-case abbreviated two- 791 letter English day of the week. If included, it MUST be one of 792 the following values: ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 794 o *byDay*: "NDay[]" (optional) An *NDay* object has the following 795 properties: 797 * *day*: "String" The day-of-the-week part of the BYDAY value in 798 iCalendar, lower-cased. MUST be one of the following values: 799 ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 801 * *nthOfPeriod*: "Number" (optional) The ordinal part of the 802 BYDAY value in iCalendar (e.g. ""+1"" or ""-3""). If present, 803 rather than representing every occurrence of the weekday 804 defined in the _day_ property of this _NDay_, it represents 805 only a specific instance within the recurrence period. The 806 value can be positive or negative, but MUST NOT be zero. A 807 negative integer means nth-last of period. 809 o *byMonthDay*: "Number[]" (optional) The BYMONTHDAY part from 810 iCalendar. The array MUST have at least one entry if included. 812 o *byMonth*: "String[]" (optional) The BYMONTH part from iCalendar. 813 Each entry is a string representation of a number, starting from 814 "1" for the first month in the calendar (e.g. ""1" " means 815 ""January"" with Gregorian calendar), with an optional ""L"" 816 suffix (see [RFC7529]) for leap months (this MUST be upper-case, 817 e.g. ""3L""). The array MUST have at least one entry if included. 819 o *byYearDay*: "Number[]" (optional) The BYYEARDAY part from 820 iCalendar. The array MUST have at least one entry if included. 822 o *byWeekNo*: "Number[]" (optional) The BYWEEKNO part from 823 iCalendar. The array MUST have at least one entry if included. 825 o *byHour*: "Number[]" (optional) The BYHOUR part from iCalendar. 826 The array MUST have at least one entry if included. 828 o *byMinute*: "Number[]" (optional) The BYMINUTE part from 829 iCalendar. The array MUST have at least one entry if included. 831 o *bySecond*: "Number[]" (optional) The BYSECOND part from 832 iCalendar. The array MUST have at least one entry if included. 834 o *bySetPosition*: "Number[]" (optional) The BYSETPOS part from 835 iCalendar. The array MUST have at least one entry if included. 837 o *count*: "Number" (optional) The COUNT part from iCalendar. This 838 MUST NOT be included if an _until_ property is specified. 840 o *until*: "LocalDate" (optional) The UNTIL part from iCalendar. 841 This MUST NOT be included if a _count_ property is specified. 842 Note, as in iCalendar, this date is presumed to be in the time 843 zone specified in _timeZone_. It is not a UTC time. 845 A recurrence rule specifies a set of set of date-times for recurring 846 calendar objects. A recurrence rule has the following semantics. 847 Note, wherever "year", "month" or "day of month" is used, this is 848 within the calendar system given by the "rscale" property, which 849 defaults to gregorian if omitted. 851 1. A set of candidates is generated. This is every second within a 852 period defined by the frequency property: 854 * *yearly*: every second from midnight on the 1st day of a year 855 (inclusive) to midnight the 1st day of the following year 856 (exclusive). 858 If skip is not "omit", the calendar system has leap months and 859 there is a byMonth property, generate candidates for the leap 860 months even if they don't occur in this year. 862 If skip is not "omit" and there is a byMonthDay property, 863 presume each month has the maximum number of days any month 864 may have in this calendar system when generating candidates, 865 even if it's more than this month actually has. 867 * *monthly*: every second from midnight on the 1st day of a 868 month (inclusive) to midnight on the 1st of the following 869 month (exclusive). 871 If skip is not "omit" and there is a byMonthDay property, 872 presume the month has the maximum number of days any month may 873 have in this calendar system when generating candidates, even 874 if it's more than this month actually has. 876 * *weekly*: every second from midnight (inclusive) on the first 877 day of the week (as defined by the firstDayOfWeek property, or 878 Monday if omitted), to midnight 7 days later (exclusive). 880 * *daily*: every second from midnight at the start of the day 881 (inclusive) to midnight at the end of the day (exclusive). 883 * *hourly*: every second from the beginning of the hour 884 (inclusive) to the beginning of the next hour (exclusive). 886 * *minutely*: every second from the beginning of the minute 887 (inclusive) to the beginning of the next minute (exclusive). 889 * *secondly*: the second itself, only. 891 2. Each date-time candidate is compared against all of the byX 892 properties of the rule except bySetPosition. If any property in 893 the rule does not match the date-time, it is eliminated. Each 894 byX property is an array; the date-time matches the property if 895 it matches any of the values in the array. The properties have 896 the following semantics: 898 * *byMonth*: the date-time is in the given month. 900 * *byWeekNo*: the date-time is in the nth week of the year. 901 Negative numbers mean the nth last week of the year. This 902 corresponds to weeks according to week numbering as defined in 903 ISO.8601.2004, with a week defined as a seven day period, 904 starting on the firstDayOfWeek property value or Monday if 905 omitted. Week number one of the calendar year is the first 906 week that contains at least four days in that calendar year. 908 If the date-time is not valid (this may happen when generating 909 candidates with a skip property in effect), it is always 910 eliminated by this property. 912 * *byYearDay*: the date-time is on the nth day of year. 913 Negative numbers mean the nth last day of the year. 915 If the date-time is not valid (this may happen when generating 916 candidates with a skip property in effect), it is always 917 eliminated by this property. 919 * *byMonthDay*: the date-time is on the given day of the month. 920 Negative numbers mean the nth last day of the month. 922 * *byDay*: the date-time is on the given day of the week. If 923 the day is prefixed by a number, it is the nth occurrence of 924 that day of the week within the month (if frequency is 925 monthly) or year (if frequency is yearly). Negative numbers 926 means nth last occurrence within that period. 928 * *byHour*: the date-time has the given hour value. 930 * *byMinute*: the date-time has the given minute value. 932 * *bySecond*: the date-time has the given second value. 934 If a skip property is defined and is not "omit", there may be 935 candidates that do not correspond to valid dates (e.g. 31st 936 Februrary in the gregorian calendar). In this case, the 937 properties MUST be considered in the order above and: 939 1. After applying the byMonth filter, if the candidate's month 940 is invalid for the given year increment it (if skip is 941 "forward") or decrement it (if skip is "backward") until a 942 valid month is found, incrementing/decrementing the year as 943 well if you pass through the beginning/end of the year. This 944 only applies to calendar systems with leap months. 946 2. After applying the byMonthDay filter, if the day of the month 947 is invalid for the given month and year, change the date to 948 the first day of the next month (if skip == "forward") or the 949 last day of the current month (if skip == "backward"). 951 3. If any valid date produced after applying the skip is already 952 a candidate, eliminate the duplicate. (For example after 953 adjusting, 30th Februrary and 31st February would both become 954 the same "real" date, so one is eliminated as a duplicate.) 956 3. If a bySetPosition property is included, this is now applied to 957 the ordered list of remaining dates (this property specifies the 958 indexes of date-times to keep; all others should be eliminated. 959 Negative numbers are indexes from the end of the list, with -1 960 being the last item). 962 4. Any date-times before the start date of the event are eliminated 963 (see below for why this might be needed). 965 5. If a skip property is included and is not "omit", eliminate any 966 date-times that have already been produced by previous iterations 967 of the algorithm. (This is not possible if skip == "omit".) 969 6. If further dates are required (we have not reached the until 970 date, or count limit) skip the next (interval - 1) sets of 971 candidates, then continue from step 1. 973 When determining the set of occurrence dates for an event or task, 974 the following extra rules must be applied: 976 1. The start date-time is always the first occurrence in the 977 expansion (and is counted if the recurrence is limited by a 978 "count" property), even if it would normally not match the rule. 980 2. The first set of candidates to consider is that which would 981 contain the start date-time. This means the first set may 982 include candidates before the start; such candidates are 983 eliminated from the results in step (4) as outlined before. 985 3. The following properties MUST be implicitly added to the rule 986 under the given conditions: 988 * If frequency > "secondly" and no bySecond property: Add a 989 bySecond property with the sole value being the seconds value 990 of the start date-time. 992 * If frequency > "minutely" and no byMinute property: Add a 993 byMinute property with the sole value being the minutes value 994 of the start date-time. 996 * If frequency > "hourly" and no byHour property: Add a byHour 997 property with the sole value being the hours value of the 998 start date-time. 1000 * If frequency is "weekly" and no byDay property: Add a byDay 1001 property with the sole value being the day-of-the-week of the 1002 start date-time. 1004 * If frequency is "monthly" and no byDay property and no 1005 byMonthDay property: Add a byMonthDay property with the sole 1006 value being the day-of-the-month of the start date-time. 1008 * If frequency is "yearly" and no byYearDay property: 1010 + if there are no byMonth or byWeekNo properties, and either 1011 there is a byMonthDay property or there is no byDay 1012 property: Add a byMonth property with the sole value being 1013 the month of the start date-time. 1015 + if there is no byMonthDay, byWeekNo or byDay properties: 1016 Add a byMonthDay property with the sole value being the 1017 day-of-the-month of the start date-time. 1019 + if there is a byWeekNo property and no byMonthDay or byDay 1020 properties: Add a byDay property with the sole value being 1021 the day-of-the-week of the start date-time. 1023 4.3.2. recurrenceOverrides 1025 Type: "LocalDate[PatchObject]" (optional) 1027 A map of the recurrence-ids (the date-time of the start of the 1028 occurrence) to an object of patches to apply to the generated 1029 occurrence object. 1031 If the recurrence-id does not match an expanded start date from a 1032 recurrence rule, it is to be treated as an additional occurrence 1033 (like an RDATE from iCalendar). The patch object may often be empty 1034 in this case. 1036 If the patch object defines the _excluded_ property to be "true", 1037 then the recurring calendar object does not occur at the recurrence- 1038 id date-time (like an EXDATE from iCalendar). Such a patch object 1039 MUST NOT patch any other property. 1041 By default, an occurrence inherits all properties from the main 1042 object except the start (or due) date-time, which is shifted to the 1043 new start time of the LocalDate key. However, individual properties 1044 of the occurrence can be modified by a patch, or multiple patches. 1045 It is valid to patch the start property value, and this patch takes 1046 precedence over the LocalDate key. Both the LocalDate key as well as 1047 the patched start date-time may occur before the original JSCalendar 1048 object's start or due date. 1050 A pointer in the PatchObject MUST NOT start with one of the following 1051 prefixes; any patch with such a key MUST be ignored: 1053 o @type 1055 o uid 1057 o relatedTo 1059 o prodId 1061 o method 1063 o isAllDay 1065 o recurrenceRule 1067 o recurrenceOverrides 1069 o replyTo 1071 4.3.3. excluded 1073 Type: "Boolean" (optional, default:"false") 1075 Defines if this object is an overridden, excluded instance of a 1076 recurring JSCalendar object (also see Section 4.3.2). If this 1077 property value is "true", this calendar object instance MUST be 1078 removed from the occurrence expansion. 1080 4.4. Sharing and scheduling properties 1082 4.4.1. priority 1084 Type: "Number" (optional, default:"0") 1086 Specifies a priority for the calendar object. This may be used as 1087 part of scheduling systems to help resolve conflicts for a time 1088 period. 1090 The priority is specified as an integer in the range 0 to 9. A value 1091 of 0 specifies an undefined priority. A value of 1 is the highest 1092 priority. A value of 2 is the second highest priority. Subsequent 1093 numbers specify a decreasing ordinal priority. A value of 9 is the 1094 lowest priority. Other integer values are reserved for future use. 1096 4.4.2. freeBusyStatus 1098 Type: "String" (optional, default:"busy") 1100 Specifies how this property should be treated when calculating free- 1101 busy state. The value MUST be one of: 1103 o ""free"": The object should be ignored when calculating whether 1104 the user is busy. 1106 o ""busy"": The object should be included when calculating whether 1107 the user is busy. 1109 4.4.3. privacy 1111 Type: "String" (optional, default:"public") 1113 Calendar objects are normally collected together and may be shared 1114 with other users. The privacy property allows the object owner to 1115 indicate that it should not be shared, or should only have the time 1116 information shared but the details withheld. Enforcement of the 1117 restrictions indicated by this property are up to the 1118 implementations. 1120 This property MUST NOT affect the information sent to scheduled 1121 participants; it is only interpreted when the object is shared as 1122 part of a shared calendar. 1124 The value MUST be either one of the following values, registered in a 1125 future RFC, or a vendor-specific value. Vendor specific values MUST 1126 be prefixed with a domain name controlled by the vendor, e.g. 1127 "example.com/topsecret". Any value the client or server doesn't 1128 understand should be preserved but treated as equivalent to 1129 "private". 1131 o "public": The full details of the object are visible to those whom 1132 the object's calendar is shared with. 1134 o "private": The details of the object are hidden; only the basic 1135 time and metadata is shared. Implementations MUST ensure the 1136 following properties are stripped when the object is accessed by a 1137 sharee: 1139 * title 1141 * description 1143 * locations 1144 * links 1146 * locale 1148 * localizations 1150 * participants 1152 * replyTo 1154 In addition, any patches in "recurrenceOverrides" whose key is 1155 prefixed with one of the above properties MUST be stripped. 1157 o "secret": The object is hidden completely (as though it did not 1158 exist) when the calendar is shared. 1160 4.4.4. replyTo 1162 Type: "String[String]" (optional) 1164 Represents methods by which participants may submit their RSVP 1165 response to the organizer of the calendar object. The keys in the 1166 property value are the available methods and MUST only contain ASCII 1167 alphanumeric characters (A-Za-z0-9). The value is a URI to use that 1168 method. Future methods may be defined in future specifications; a 1169 calendar client MUST ignore any method it does not understand, but 1170 MUST preserve the method key and URI. This property MUST be omitted 1171 if no method is defined (rather than an empty object). 1173 The following methods are defined: 1175 o "imip": The organizer accepts an iMIP [RFC6047] response at this 1176 email address. The value MUST be a "mailto:" URI. 1178 o "web": Opening this URI in a web browser will provide the user 1179 with a page where they can submit a reply to the organizer. 1181 o "other": The organizer is identified by this URI but the method 1182 how to submit the RSVP is undefined. 1184 4.4.5. participants 1186 Type: "String[Participant]" (optional) 1188 A map of participant ids to participants, describing their 1189 participation in the calendar object. A participant id MUST be 1190 unique to this calendar object; a UUID or the base-64 encoded email 1191 address of the participant is a good choice. 1193 A *Participant* object has the following properties: 1195 o *name*: "String" (optional) The display name of the participant 1196 (e.g. "Joe Bloggs"). 1198 o *email*: "String" (optional) The email address for the 1199 participant. 1201 o *sendTo*: "String[String]" Represents methods by which the 1202 participant may receive the invitation and updates to the calendar 1203 object. 1205 The keys in the property value are the available methods and MUST 1206 only contain ASCII alphanumeric characters (A-Za-z0-9). The value 1207 is a URI to use that method. Future methods may be defined in 1208 future specifications; a calendar client MUST ignore any method it 1209 does not understand, but MUST preserve the method key and URI. 1210 This property MUST be omitted if no method is defined (rather than 1211 an empty object). 1213 The following methods are defined: 1215 * "imip": The participant accepts an iMIP [RFC6047] request at 1216 this email address. The value MUST be a "mailto:" URI. It MAY 1217 be different from the value of the participant's _email_ 1218 property. 1220 * "other": The participant is identified by this URI but the 1221 method how to submit the invitation or update is undefined. 1223 o *kind*: "String" (optional) What kind of entity this participant 1224 is, if known. 1226 This MUST be either one of the following values, registered in a 1227 future RFC, or a vendor-specific value. Any value the client or 1228 server doesn't understand should be treated the same as if this 1229 property is omitted. 1231 * "individual": a single person 1233 * "group": a collection of people invited as a whole 1235 * "resource": a non-human resource, e.g. a projector 1237 * "location": a physical location involved in the calendar object 1238 that needs to be scheduled, e.g. a conference room. 1240 o *roles*: "String[Boolean]" A set of roles that this participant 1241 fulfills. 1243 At least one role MUST be specified for the participant. The keys 1244 in the set MUST be either one of the following values, registered 1245 in a future RFC, or a vendor-specific value: 1247 * "owner": The participant is an owner of the object. 1249 * "attendee": The participant is an attendee of the calendar 1250 object. 1252 * "chair": The participant is in charge of the calendar object 1253 when it occurs. 1255 The value for each key in the set MUST be "true". Roles that are 1256 unknown to the implementation MUST be preserved and MAY be 1257 ignored. 1259 o *locationId*: "String" (optional) The location at which this 1260 participant is expected to be attending. 1262 If the value does not correspond to any location id in the 1263 _locations_ property of the instance, this MUST be treated the 1264 same as if the participant's locationId were omitted. 1266 o *participationStatus*: "String" (optional, default:"needs-action") 1267 The participation status, if any, of this participant. 1269 The value MUST be either one of the following values, registered 1270 in a future RFC, or a vendor-specific value: 1272 * "needs-action": No status yet set by the participant. 1274 * "accepted": The invited participant will participate. 1276 * "declined": The invited participant will not participate. 1278 * "tentative": The invited participant may participate. 1280 o *attendance*: "String" (optional, default:"required") The required 1281 attendance of this participant. 1283 The value MUST be either one of the following values, registered 1284 in a future RFC, or a vendor-specific value. Any value the client 1285 or server doesn't understand should be treated the same as 1286 "required". 1288 * "none": Indicates a participant who is copied for information 1289 purposes only. 1291 * "optional": Indicates a participant whose attendance is 1292 optional. 1294 * "required": Indicates a participant whose attendance is 1295 required. 1297 o *expectReply*: "Boolean" (optional, default:"false") If true, the 1298 organizer is expecting the participant to notify them of their 1299 status. 1301 o *scheduleSequence*: "Number" (optional, default:"0") The sequence 1302 number of the last response from the participant. If defined, 1303 this MUST be a non-negative integer. 1305 This can be used to determine whether the participant has sent a 1306 new RSVP following significant changes to the calendar object, and 1307 to determine if future responses are responding to a current or 1308 older view of the data. 1310 o *scheduleUpdated*: "UTCDate" (optional) The _updated_ property of 1311 the last iMIP response from the participant. 1313 This can be compared to the _updated_ timestamp in future iMIP 1314 responses to determine if the response is older or newer than the 1315 current data. 1317 o *invitedBy*: "String" (optional) The participant id of the 1318 participant who invited this one, if known. 1320 o *delegatedTo*: "String[Boolean]" (optional) A set of participant 1321 ids that this participant has delegated their participation to. 1322 Each key in the set MUST be the identifier of a participant. The 1323 value for each key in the set MUST be "true". This MUST be 1324 omitted if none (rather than an empty set). 1326 o *delegatedFrom*: "String[Boolean]" (optional) A set of participant 1327 ids that this participant is acting as a delegate for. Each key 1328 in the set MUST be the identifier of a participant. The value for 1329 each key in the set MUST be "true". This MUST be omitted if none 1330 (rather than an empty set). 1332 o *memberOf*: "String[Boolean]" (optional) A set of group 1333 participants that were invited to this calendar object, which 1334 caused this participant to be invited due to their membership of 1335 the group(s). Each key in the set MUST be the identifier of a 1336 participant. The value for each key in the set MUST be "true". 1337 This MUST be omitted if none (rather than an empty set). 1339 o *linkIds*: "String[Boolean]" (optional) A set of links to more 1340 information about this participant, for example in vCard format. 1341 The keys in the set MUST be the identifier of a Link object in the 1342 calendar object's _links_ property. The value for each key in the 1343 set MUST be "true". This MUST be omitted if none (rather than an 1344 empty set). 1346 4.5. Alerts properties 1348 4.5.1. useDefaultAlerts 1350 Type: "Boolean" (optional, default:"false") 1352 If "true", use the user's default alerts and ignore the value of the 1353 _alerts_ property. Fetching user defaults is dependent on the API 1354 from which this JSCalendar object is being fetched, and is not 1355 defined in this specification. If an implementation cannot determine 1356 the user's default alerts, or none are set, it MUST process the 1357 alerts property as if useDefaultAlerts is set to "false". 1359 4.5.2. alerts 1361 Type: "String[Alert]" (optional) 1363 A map of alert ids to Alert objects, representing alerts/reminders to 1364 display or send the user for this calendar object. The id MUST be 1365 unique to this calendar object; a UUID is a practical choice. 1367 An *Alert* Object has the following properties: 1369 o *relativeTo*: "String" (optional, default:"before-start") 1370 Specifies where the offset is relative to for the alarm to 1371 trigger. The value MUST be one of: 1373 * "before-start" 1375 * "after-start" 1377 * "before-end" 1379 * "after-end" 1381 o *offset*: "Duration" The offset from the start and end/due of the 1382 calendar object to fire the alert. If the calendar object does 1383 not define a time zone, the user's default time zone SHOULD be 1384 used when determining the offset, if known. Otherwise, the time 1385 zone to use is implementation specific. 1387 o *acknowledged*: "UTCDate" (optional) 1389 When the user has permanently dismissed the alert the client MUST 1390 set this to the current time in UTC. Other clients which sync 1391 this property can then automatically dismiss or suppress duplicate 1392 alerts (alerts with the same alert id that triggered on or before 1393 this date-time). 1395 For a recurring calendar object, the _acknowledged_ property of 1396 the parent object MUST be updated, unless the alert is already 1397 overridden in _recurrenceOverrides_. 1399 o *snoozed*: "UTCDate" (optional) 1401 If the user temporarily dismisses the alert, this is the UTC date- 1402 time after which it should trigger again. Setting this property 1403 on an instance of a recurring calendar object MUST update the 1404 alarm on the master object, unless the respective instance already 1405 is defined in "recurrenceOverrides". It MUST NOT generate an 1406 override for the sole use of snoozing an alarm. 1408 o *action*: "String" (optional, default:"display") Describes how to 1409 alert the user. 1411 The value MUST be at most one of the following values, registered 1412 in a future RFC, or a vendor-specific value: 1414 * "display": The alert should be displayed as appropriate for the 1415 current device and user context. 1417 * "email": The alert should trigger an email sent out to the 1418 user, notifying about the alert. This action is typically only 1419 appropriate for server implementations. 1421 4.6. Multilingual properties 1423 4.6.1. localizations 1425 Type: "String[PatchObject]" (optional) 1427 A map of [RFC5646] language tags to patch objects, which localize the 1428 calendar object into the locale of the respective language tag. 1430 See the description of PatchObject (Section 3.2.4) for the structure 1431 of the PatchObject. The patches are applied to the top-level object. 1433 In addition to all the restrictions on patches specified there, the 1434 pointer also MUST NOT start with one of the following prefixes; any 1435 patch with a such a key MUST be ignored: 1437 o @type 1439 o due 1441 o duration 1443 o freeBusyStatus 1445 o localization 1447 o method 1449 o participants 1451 o prodId 1453 o progress 1455 o relatedTo 1457 o sequence 1459 o start 1461 o status 1463 o timeZone 1465 o uid 1467 o useDefaultAlerts 1469 Note that this specification does not define how to maintain validity 1470 of localized content. For example, a client application changing a 1471 JSCalendar object's title property might also need to update any 1472 localizations of this property. Client implementations SHOULD 1473 provide the means to manage localizations, but how to achieve this is 1474 specific to the application's workflow and requirements. 1476 5. Type-specific JSCalendar properties 1477 5.1. JSEvent properties 1479 In addition to the common JSCalendar object properties (Section 4) a 1480 JSEvent has the following properties: 1482 5.1.1. start 1484 Type: "LocalDate" e.g. "2015-09-02T00:00:00" 1486 The date/time the event would start in the event's time zone. 1488 A valid JSEvent MUST include this property. 1490 5.1.2. timeZone 1492 Type: "String|null" (optional, default:"null") 1494 The IANA Time Zone Database [3] name for the time zone the event is 1495 scheduled in, or "null" for floating time. If omitted, this MUST be 1496 presumed to be "null" (i.e. floating time). 1498 5.1.3. duration 1500 Type: "Duration", e.g. "P2DT3H" (optional, default: "PT0S") 1502 The zero or positive duration of the event in the event's start time 1503 zone. The same rules as for the iCalendar DURATION value type 1504 ([RFC5545]) apply: The duration of a week or a day in hours/minutes/ 1505 seconds may vary if it overlaps a period of discontinuity in the 1506 event's time zone, for example a change from standard time to 1507 daylight-savings time. Leap seconds MUST NOT be considered when 1508 computing an exact duration. When computing an exact duration, the 1509 greatest order time components MUST be added first, that is, the 1510 number of days MUST be added first, followed by the number of hours, 1511 number of minutes, and number of seconds. Fractional seconds MUST be 1512 added last. 1514 A JSEvent MAY involve start and end locations that are in different 1515 time zones (e.g. a trans-continental flight). This can be expressed 1516 using the _rel_ and _timeZone_ properties of the JSEvent's _location_ 1517 objects. 1519 5.1.4. isAllDay 1521 Type: "Boolean" (optional, default:"false") 1523 Specifies if the event is an all day event, such as a birthday or 1524 public holiday. 1526 If _isAllDay_ is true, then the following restrictions apply: 1528 o the _start_ property MUST have a time component of "T00:00:00". 1530 o the _duration_ property MUST NOT include non-zero time components 1531 (hours, minutes, or seconds). 1533 Note that all-day events MAY be bound to a specific time zone, as 1534 defined by the _timeZone_ property. 1536 5.1.5. status 1538 Type: "String" (optional, default:"confirmed") 1540 The scheduling status (Section 4.4) of a JSEvent. If set, it MUST be 1541 one of: 1543 o "confirmed": Indicates the event is definite. 1545 o "cancelled": Indicates the event is cancelled. 1547 o "tentative": Indicates the event is tentative. 1549 5.2. JSTask properties 1551 In addition to the common JSCalendar object properties (Section 4) a 1552 JSTask has the following properties: 1554 5.2.1. due 1556 Type: "LocalDate" (optional) e.g. "2015-09-02T00:00:00" 1558 The date/time the task is due in the task's time zone. 1560 5.2.2. start 1562 Type: "LocalDate" (optional) e.g. "2015-09-02T00:00:00" 1564 The date/time the task should start in the task's time zone. 1566 5.2.3. timeZone 1568 Type: "String|null" (optional, default:"null") 1570 The IANA Time Zone Database name for the time zone the task is 1571 scheduled in, or "null" for floating time. If omitted, this MUST be 1572 presumed to be "null" (i.e. floating time). 1574 5.2.4. estimatedDuration 1576 Type: "Duration" (optional), e.g. "P2DT3H" 1578 Specifies the estimated positive duration of time the task takes to 1579 complete. 1581 5.2.5. statusUpdatedAt 1583 Type: "UTCDate" (optional), e.g. "2016-06-13T12:00:00Z" 1585 Specifies the date/time the task status properties was last updated. 1587 If the task is recurring and has future instances, a client may want 1588 to keep track of the last status update timestamp of a specific task 1589 recurrence, but leave other instances unchanged. One way to achieve 1590 this is by overriding the statusUpdatedAt property in the task 1591 _recurrenceOverrides_. However, this could produce a long list of 1592 timestamps for regularly recurring tasks. An alternative approach is 1593 to split the JSTask into a current, single instance of JSTask with 1594 this instance status update time and a future recurring instance. 1595 Also see the definition of the _relatedTo_ on splitting. 1597 5.2.6. isAllDay 1599 Type: "Boolean" (optional, default:"false") 1601 Specifies if the task is an all day task. 1603 If _isAllDay_ is true, then the _start_ and _due_ properties MUST 1604 have a time component of "T00:00:00". Note that the 1605 _estimatedDuration_ property MAY contain a non-zero time duration. 1606 All-day tasks MAY be bound to a specific time zone, as defined by the 1607 _timeZone_ property. 1609 5.2.7. progress 1611 In addition to the common properties of a _Participant_ object 1612 (Section 4.4.5), a Participant within a JSTask supports the following 1613 property: 1615 o *progress*: "ParticipantProgress" (optional) The progress of the 1616 participant for this task, if known. This property MUST NOT be 1617 set if the _participationStatus_ of this participant is any other 1618 value but "accepted". 1620 A *ParticipantProgress* object has the following properties: 1622 o *status*: "String" Describes the completion status of the 1623 participant's progress. 1625 The value MUST be at most one of the following values, registered 1626 in a future RFC, or a vendor-specific value: 1628 * "completed": The participant completed their task. 1630 * "in-process": The participant has started this task. 1632 * "failed": The participant failed to complete their task. 1634 o *timestamp*: "UTCDate" Describes the last time when the 1635 participant progress got updated. 1637 5.2.8. status 1639 Type: "String" 1641 Defines the overall status of this task. If omitted, the default 1642 status (Section 4.4) of a JSTask is defined as follows (in order of 1643 evaluation): 1645 o "completed": if all the _ParticipantProgress_ status of the task 1646 participants is "completed". 1648 o "failed": if at least one _ParticipantProgress_ status of the task 1649 participants is "failed". 1651 o "in-process": if at least one _ParticipantProgress_ status of the 1652 task participants is "in-process". 1654 o "needs-action": If none of the other criteria match. 1656 If set, it MUST be one of: 1658 o "needs-action": Indicates the task needs action. 1660 o "completed": Indicates the task is completed. 1662 o "in-process": Indicates the task is in process. 1664 o "cancelled": Indicates the task is cancelled. 1666 o "pending": Indicates the task has been created and accepted for 1667 processing, but not yet started. 1669 o "failed": Indicates the task failed. 1671 5.3. JSGroup properties 1673 JSGroup supports the following JSCalendar properties (Section 4): 1675 o @type 1677 o uid 1679 o created 1681 o updated 1683 o categories 1685 o keywords 1687 o name 1689 o description 1691 o color 1693 o links 1695 as well as the following JSGroup-specific properties: 1697 5.3.1. entries 1699 Type: "String[JSTask|JSEvent]" 1701 A collection of group members. This is represented as a map of the 1702 _uid_ property value to the JSCalendar object member having that uid. 1703 Implementations MUST ignore entries of unknown type. 1705 5.3.2. source 1707 Type: "String" (optional) 1709 The source from which updated versions of this group may be retrieved 1710 from. The value MUST be a URI. 1712 6. Conversion from and to iCalendar 1714 This section specifies which JSCalendar properties can be mapped from 1715 and to iCalendar format. Implementations SHOULD follow these 1716 conversion guidelines. Still, JSCalendar does not restrict itself to 1717 iCalendar and conversion between these two formats MAY be lossy. 1719 6.1. JSEvent 1721 The iCalendar counterpart to _JSEvent_ is the VEVENT component type 1722 [RFC5545]. A VEVENT component that is a direct child of a VCALENDAR 1723 component is equivalent to a standalone JSEvent. A VEVENT component 1724 within a VEVENT maps to the entries of the JSEvent 1725 _recurrenceOverrides_ property. 1727 +----------+--------------------------------------------------------+ 1728 | Property | iCalendar counterpart | 1729 +----------+--------------------------------------------------------+ 1730 | isAllDay | True, if the type of the DTSTART property in iCalendar | 1731 | | is DATE. When translating from JSCalendar the | 1732 | | iCalendar DTSTART property is of DATE value type, if | 1733 | | the _isAllDay_ property is set to true and the | 1734 | | _timeZone_ property is null. | 1735 | | | 1736 | start | Corresponds to the DTSTART property in iCalendar. Note | 1737 | | that time zone information is stored separately in | 1738 | | JSEvent. | 1739 | | | 1740 | timeZone | Corresponds to the TZID part of the DTSTART property | 1741 | | in iCalendar. If the event has a different end time | 1742 | | zone to start time zone, this should be added as a | 1743 | | JSCalendar _location_ with just a _timeZone_ property | 1744 | | and "rel="end"". | 1745 | | | 1746 | duration | Corresponds to the DURATION or DSTART+DTEND properties | 1747 | | in iCalendar. | 1748 +----------+--------------------------------------------------------+ 1750 Table 1: Translation between JSEvent and iCalendar 1752 6.2. JSTask 1754 The iCalendar counterpart to _JSTask_ is the VTODO component type 1755 [RFC5545]. A VTODO component that is a direct child of a VCALENDAR 1756 component is equivalent to a standalone JSTask. A VTODO component 1757 within a master VTODO maps to the entries of the JSTask 1758 _recurrenceOverrides_ property. 1760 +-------------------+-----------------------------------------------+ 1761 | Property | iCalendar counterpart | 1762 +-------------------+-----------------------------------------------+ 1763 | isAllDay | True, if the type of the DTSTART property in | 1764 | | iCalendar is DATE. When translating from | 1765 | | JSCalendar the iCalendar DTSTART property is | 1766 | | of DATE value type, if the _isAllDay_ | 1767 | | property is set to true and the _timeZone_ | 1768 | | property is null. | 1769 | | | 1770 | due | Corresponds to the DUE and DTSTART+DURATION | 1771 | | properties in iCalendar. When mapping | 1772 | | iCalendar VTODOs with DTSTART+DURATION, the | 1773 | | due date is the result of adding DURATION to | 1774 | | DTSTART in the DTSTART time zone. | 1775 | | | 1776 | start | Corresponds to the DTSTART property in | 1777 | | iCalendar. | 1778 | | | 1779 | timeZone | Corresponds to the TZID part of the | 1780 | | DTSTART/DUE properties in iCalendar. If the | 1781 | | task has a different end time zone to start | 1782 | | or due time zone, this should be added as a | 1783 | | JSCalendar _location_ with just a _timeZone_ | 1784 | | property and "rel="end"". | 1785 | | | 1786 | estimatedDuration | Corresponds to the ESTIMATED-DURATION | 1787 | | iCalendar property in the RFC draft | 1788 | | [draft-apthorp-ical-tasks]. | 1789 | | | 1790 | statusUpdatedAt | Maps to the COMPLETED iCalendar property. The | 1791 | | JSTask status property MUST have value | 1792 | | "completed". | 1793 | | | 1794 | progress | Corresponds to the PARTSTAT and COMPLETED | 1795 | | properties in iCalendar, including the | 1796 | | definitions in the RFC draft | 1797 | | [draft-apthorp-ical-tasks]. | 1798 | | | 1799 | status | Corresponds to the STATUS property in | 1800 | | iCalendar, including the definitions in the | 1801 | | RFC draft [draft-apthorp-ical-tasks]. | 1802 +-------------------+-----------------------------------------------+ 1804 Table 2: Translation between JSTask and iCalendar 1806 6.3. JSGroup 1808 A JSGroup converts to a iCalendar VCALENDAR containing VEVENT or 1809 VTODO components. 1811 +----------+--------------------------------------------------------+ 1812 | Property | iCalendar counterpart | 1813 +----------+--------------------------------------------------------+ 1814 | entries | The VEVENT and VTODO components within a top-level | 1815 | | VCALENDAR component. | 1816 | | | 1817 | source | Corresponds to the SOURCE property in iCalendar. | 1818 +----------+--------------------------------------------------------+ 1820 Table 3: Translation between JSGroup and iCalendar 1822 6.4. Common properties 1824 +------------------------+------------------------------------------+ 1825 | Property | iCalendar counterpart | 1826 +------------------------+------------------------------------------+ 1827 | alerts | An _Alert_ corresponds to the VALARM | 1828 | | component in iCalendar, where the | 1829 | | _action_ is determined by the iCalendar | 1830 | | ACTION property value (e.g., both | 1831 | | "DISPLAY" and "AUDIO" actions map to a | 1832 | | JSCalendar _display_ action, and | 1833 | | similarly for "EMAIL"). The | 1834 | | _relativeTo_ and _offset_ properties | 1835 | | corresponds to the iCalendar TRIGGER | 1836 | | property. | 1837 | | | 1838 | categories | Corresponds to the CONCEPT property in | 1839 | | iCalendar, see in the RFC draft | 1840 | | [draft-ietf-calext-ical-relations]. | 1841 | | | 1842 | color | Corresponds to the COLOR property in | 1843 | | iCalendar, as specified in [RFC7986]. | 1844 | | | 1845 | created | Corresponds to the CREATED property in | 1846 | | iCalendar. | 1847 | | | 1848 | description | Corresponds to the DESCRIPTION property | 1849 | | and its ALTREP parameters in iCalendar. | 1850 | | | 1851 | descriptionContentType | Implementation-specific. | 1852 | | | 1853 | freeBusyStatus | Corresponds to the TRANSP property in | 1854 | | iCalendar. | 1855 | | | 1856 | keywords | Corresponds to the CATEGORIES property | 1857 | | in iCalendar, as specified in [RFC7986]. | 1858 | | | 1859 | links | Corresponds to the ATTACH ([RFC5545]) or | 1860 | | IMAGE ([RFC7986]) properties with a URI | 1861 | | value type set to the link "href". | 1862 | | ([RFC7986]). The _type_ property | 1863 | | corresponds to the FMTTYPE parameter, | 1864 | | the _size_ property to the SIZE | 1865 | | parameter. Mapping all other properties | 1866 | | is implementation-specific. | 1867 | | | 1868 | locale | Corresponds to the LANGUAGE parameter in | 1869 | | iCalendar, which is added to individual | 1870 | | properties. When converting from | 1871 | | iCalendar, one language must be picked | 1872 | | as the main locale for the object, and | 1873 | | all properties in other languages moved | 1874 | | to the localizations JSEvent property. | 1875 | | | 1876 | localizations | Implementation-specific. | 1877 | | | 1878 | locations | See Section 6.5. | 1879 | | | 1880 | method | Corresponds to the METHOD property of | 1881 | | the embedding VCALENDAR in iCalendar. | 1882 | | | 1883 | participants | See Section 6.5. | 1884 | | | 1885 | priority | Corresponds to the PRIORITY property in | 1886 | | iCalendar. | 1887 | | | 1888 | privacy | Corresponds to the CLASS property in | 1889 | | iCalendar. | 1890 | | | 1891 | prodId | Corresponds to the PRODID property in | 1892 | | iCalendar. | 1893 | | | 1894 | recurrenceOverrides | Corresponds to the RDATE and EXDATE | 1895 | | properties in iCalendar, plus VEVENT | 1896 | | (for JSEvent) or VTODO (for JSTask) | 1897 | | instances with a recurrence-id. | 1898 | | | 1899 | recurrenceRule | Corresponds to the RRULE property in | 1900 | | iCalendar. See the property definition | 1901 | | at section Section 4.3.1 how to map a | 1902 | | RRULE value. | 1903 | | | 1904 | relatedTo | Corresponds to the RELATED-TO property | 1905 | | in iCalendar. | 1906 | | | 1907 | replyTo | An iCalendar ORGANIZER with a mailto: | 1908 | | URI mapped to the "imip" method, or any | 1909 | | other URI mapped to the "other" method. | 1910 | | Mapping multiple methods is | 1911 | | implementation-specific. | 1912 | | | 1913 | sequence | Corresponds to the SEQUENCE property in | 1914 | | iCalendar. | 1915 | | | 1916 | status | Corresponds to the STATUS property in | 1917 | | iCalendar (converted to lower-case). | 1918 | | | 1919 | title | Corresponds to the SUMMARY property in | 1920 | | iCalendar. | 1921 | | | 1922 | uid | Corresponds to the UID property in | 1923 | | iCalendar. | 1924 | | | 1925 | updated | Corresponds to the DTSTAMP and LAST- | 1926 | | MODIFIED properties in iCalendar. (These | 1927 | | are only different in the iTIP case, and | 1928 | | the difference is not actually useful.) | 1929 +------------------------+------------------------------------------+ 1931 Table 4: Translation between JSCalendar and iCalendar 1933 6.5. Locations and participants 1935 Both JSCalendar participants and locations have counterparts in 1936 iCalendar but provide richer representation. 1938 The following table outlines translation of JSCalendar participants. 1939 Where iCalendar has distinct properties for ORGANIZER and ATTENDEE, 1940 these are merged in JSCalendar into the Participant object type. 1942 +---------------------+---------------------------------------------+ 1943 | Property | iCalendar counterpart | 1944 +---------------------+---------------------------------------------+ 1945 | delegatedFrom | the DELEGATED-FROM parameter | 1946 | | | 1947 | delegatedTo | the DELEGATED-TO parameter | 1948 | | | 1949 | expectReply | the RSVP parameter | 1950 | | | 1951 | email | The value of the EMAIL parameter of the | 1952 | | ORGANIZER or ATTENDEE property, if defined. | 1953 | | Otherwise the property value, if it is a | 1954 | | mailto: URI. | 1955 | | | 1956 | sendTo | An iCalendar ATTENDEE with a mailto: URI | 1957 | | mapped to the "imip" method, or any other | 1958 | | URI mapped to the "other" method. Mapping | 1959 | | multiple methods is implementation- | 1960 | | specific. | 1961 | | | 1962 | kind | the CUTYPE parameter | 1963 | | | 1964 | linkIds | Implementation-specific. | 1965 | | | 1966 | locationId | Implementation-specific. When mapping from | 1967 | | iCalendar to JSCalendar this may be the | 1968 | | JSCalendar identifier of a CONFERENCE | 1969 | | property that has the MODERATOR feature | 1970 | | defined in its FEATURE parameter values. If | 1971 | | multiple such CONFERENCE properties are | 1972 | | defined in iCalendar, then the one with the | 1973 | | most interactive features is chosen. | 1974 | | | 1975 | memberOf | the MEMBER parameter | 1976 | | | 1977 | name | the CN parameter | 1978 | | | 1979 | attendance | Maps to the standard iCalendar ROLE | 1980 | | parameter values REQ-PARTICIPANT, OPT- | 1981 | | PARTICIPANT and NON-PARTICIPANT. | 1982 | | | 1983 | roles | The "chair" role maps to the standard | 1984 | | iCalendar ROLE parameter value "chair", | 1985 | | with an implicit participant of value | 1986 | | "required". The mapping of non-required | 1987 | | chairs and other roles is implementation- | 1988 | | specific, but using "x-name" parameter | 1989 | | values is recommended. | 1990 | | | 1991 | participationStatus | the PARTSTAT parameter | 1992 | | | 1993 | scheduleSequence | the SEQUENCE property of the participant's | 1994 | | latest iMIP message | 1995 | | | 1996 | scheduleUpdated | the DTSTAMP property of the participant's | 1997 | | latest iMIP message | 1998 +---------------------+---------------------------------------------+ 2000 Table 5: Translation of Participant between JSCalendar and iCalendar 2002 The iCalendar counterpart for JSCalendar Location objects is the 2003 iCalendar [RFC5545] LOCATION property, or implementation-specific. 2005 +-------------+-----------------------------------------------------+ 2006 | Property | iCalendar counterpart | 2007 +-------------+-----------------------------------------------------+ 2008 | name | Corresponds to the LOCATION property value. | 2009 | | | 2010 | description | Implementation-specific. | 2011 | | | 2012 | rel | Implementation-specific. | 2013 | | | 2014 | timeZone | Implementation-specific. | 2015 | | | 2016 | coordinates | Implementation-specific. Consider using a GEO | 2017 | | iCalendar property, along with one LOCATION. | 2018 | | | 2019 | uri | Corresponds to the LOCATION ALTREP parameter. | 2020 | | | 2021 | linkIds | Implementation-specific. | 2022 +-------------+-----------------------------------------------------+ 2024 Table 6: Translation of Location between JSCalendar and iCalendar 2026 The iCalendar counterpart for JSCalendar VirtualLocation objects is 2027 the iCalendar [RFC7986] CONFERENCE property, or implementation- 2028 specific. 2030 +--------------+--------------------------------------------------+ 2031 | Property | iCalendar counterpart | 2032 +--------------+--------------------------------------------------+ 2033 | name | Corresponds to the CONFERENCE LABEL parameter. | 2034 | | | 2035 | description | Implementation-specific. | 2036 | | | 2037 | uri | Corresponds to the CONFERENCE property value. | 2038 +--------------+--------------------------------------------------+ 2040 Table 7: Translation of VirtualLocation between JSCalendar and 2041 iCalendar 2043 6.6. Unknown properties 2045 Both JSCalendar and iCalendar calendar objects may contain properties 2046 that are not expressible in the other format. This specification 2047 does not mandate how to preserve these properties. Instead, it 2048 leaves negotiation on how to treat unknown properties to client and 2049 server implementations and their protocol used to exchange calendar 2050 objects. 2052 Two notable options to represent and preserve arbitrary iCalendar 2053 object properties in JSCalendar are: 2055 o _JCal_: Define iCalendar properties in JCal format ([RFC7265]) in 2056 a vendor-specific property of the JCalendar object. The JCal- 2057 formatted value may either only contain iCalendar properties that 2058 were not mapped to JSCalendar properties, or contain the complete 2059 iCalendar object representation. 2061 o _Alternate link_: Define an alternate link (Section 4.2.6) value 2062 pointing to the iCalendar representation of the JSCalendar object. 2063 E.g. the alternative representation of a VEVENT would be 2064 represented as a link with rel "alternate" and type "text/ 2065 calendar;component=VEVENT". 2067 7. JSCalendar object examples 2069 The following examples illustrate several aspects of the JSCalendar 2070 data model and format. The examples may omit mandatory or additional 2071 properties, which is indicated by a placeholder property with key 2072 "...". While most of the examples use calendar event objects, they 2073 are also illustrative for tasks. 2075 7.1. Simple event 2077 This example illustrates a simple one-time event. It specifies a 2078 one-time event that begins on January 15, 2018 at 1pm New York local 2079 time and ends after 1 hour. 2081 { 2082 "@type": "jsevent", 2083 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 2084 "updated": "2018-01-15T18:00:00Z", 2085 "title": "Some event", 2086 "start": "2018-01-15T13:00:00", 2087 "timeZone": "America/New_York", 2088 "duration": "PT1H" 2089 } 2091 7.2. Simple task 2093 This example illustrates a simple task for a plain to-do item. 2095 { 2096 "@type": "jstask", 2097 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 2098 "updated": "2018-01-15T18:00:00Z", 2099 "title": "Do something" 2100 } 2102 7.3. Simple group 2104 This example illustrates a simple calendar object group that contains 2105 an event and a task. 2107 { 2108 "@type": "jsgroup", 2109 "uid": "2a358cee-6489-4f14-a57f-c104db4dc343", 2110 "updated": "2018-01-15T18:00:00Z", 2111 "name": "A simple group", 2112 "entries": [ 2113 { 2114 "@type": "jsevent", 2115 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 2116 "updated": "2018-01-15T18:00:00Z", 2117 "title": "Some event", 2118 "start": "2018-01-15T13:00:00", 2119 "timeZone": "America/New_York", 2120 "duration": "PT1H" 2121 }, 2122 { 2123 "@type": "jstask", 2124 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 2125 "updated": "2018-01-15T18:00:00Z", 2126 "title": "Do something" 2127 } 2128 ] 2129 } 2131 7.4. All-day event 2133 This example illustrates an event for an international holiday. It 2134 specifies an all-day event on April 1 that occurs every year since 2135 the year 1900. 2137 { 2138 "...": "", 2139 "title": "April Fool's Day", 2140 "isAllDay": true, 2141 "start": "1900-04-01T00:00:00", 2142 "duration": "P1D", 2143 "recurrenceRule": { 2144 "frequency": "yearly" 2145 } 2146 } 2148 7.5. Task with a due date 2150 This example illustrates a task with a due date. It is a reminder to 2151 buy groceries before 6pm Vienna local time on January 19, 2018. The 2152 calendar user expects to need 1 hour for shopping. 2154 { 2155 "...": "", 2156 "title": "Buy groceries", 2157 "due": "2018-01-19T18:00:00", 2158 "timeZone": "Europe/Vienna", 2159 "estimatedDuration": "PT1H" 2160 } 2162 7.6. Event with end time-zone 2164 This example illustrates the use of end time-zones by use of an 2165 international flight. The flight starts on April 1, 2018 at 9am in 2166 Berlin local time. The duration of the flight is scheduled at 10 2167 hours 30 minutes. The time at the flights destination is in the same 2168 time-zone as Tokyo. Calendar clients could use the end time-zone to 2169 display the arrival time in Tokyo local time and highlight the time- 2170 zone difference of the flight. The location names can serve as input 2171 for navigation systems. 2173 { 2174 "...": "", 2175 "title": "Flight XY51 to Tokyo", 2176 "start": "2018-04-01T09:00:00", 2177 "timeZone": "Europe/Berlin", 2178 "duration": "PT10H30M", 2179 "locations": { 2180 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2181 "rel": "start", 2182 "name": "Frankfurt Airport (FRA)" 2183 }, 2184 "c2c7ac67-dc13-411e-a7d4-0780fb61fb08": { 2185 "rel": "end", 2186 "name": "Narita International Airport (NRT)", 2187 "timeZone": "Asia/Tokyo" 2188 } 2189 } 2190 } 2192 7.7. Floating-time event (with recurrence) 2194 This example illustrates the use of floating-time. Since January 1, 2195 2018, a calendar user blocks 30 minutes every day to practice Yoga at 2196 7am local time, in whatever time-zone the user is located on that 2197 date. 2199 { 2200 "...": "", 2201 "title": "Yoga", 2202 "start": "2018-01-01T07:00:00", 2203 "duration": "PT30M", 2204 "recurrenceRule": { 2205 "frequency": "daily" 2206 } 2207 } 2209 7.8. Event with multiple locations and localization 2211 This example illustrates an event that happens at both a physical and 2212 a virtual location. Fans can see a live convert on premises or 2213 online. The event title and descriptions are localized. 2215 { 2216 "...": "", 2217 "title": "Live from Music Bowl: The Band", 2218 "description": "Go see the biggest music event ever!", 2219 "locale": "en", 2220 "start": "2018-07-04T17:00:00", 2221 "timeZone": "America/New_York", 2222 "duration": "PT3H", 2223 "locations": { 2224 "c0503d30-8c50-4372-87b5-7657e8e0fedd": { 2225 "name": "The Music Bowl", 2226 "description": "Music Bowl, Central Park, New York", 2227 "coordinates": "geo:40.7829,73.9654" 2228 } 2229 }, 2230 "virtualLocations": { 2231 "6f3696c6-1e07-47d0-9ce1-f50014b0041a": { 2232 "name": "Free live Stream from Music Bowl", 2233 "uri": "https://stream.example.com/the_band_2018" 2234 } 2235 }, 2236 "localizations": { 2237 "de": { 2238 "title": "Live von der Music Bowl: The Band!", 2239 "description": "Schau dir das groesste Musikereignis an!", 2240 "virtualLocations/6f3696c6-1e07-47d0-9ce1-f50014b0041a/name": 2241 "Gratis Live-Stream aus der Music Bowl" 2242 } 2243 } 2244 } 2246 7.9. Recurring event with overrides 2248 This example illustrates the use of recurrence overrides. A math 2249 course at a University is held for the first time on January 8, 2018 2250 at 9am London time and occurs every week until June 25, 2018. Each 2251 lecture lasts for one hour and 30 minutes and is located at the 2252 Mathematics department. This event has exceptional occurrences: at 2253 the last occurrence of the course is an exam, which lasts for 2 hours 2254 and starts at 10am. Also, the location of the exam differs from the 2255 usual location. On April 2 no course is held. On January 5 at 2pm 2256 is an optional introduction course, that occurs before the first 2257 regular lecture. 2259 { 2260 "...": "", 2261 "title": "Calculus I", 2262 "start": "2018-01-08T09:00:00", 2263 "timeZone": "Europe/London", 2264 "duration": "PT1H30M", 2265 "locations": { 2266 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2267 "title": "Math lab room 1", 2268 "description": "Math Lab I, Department of Mathematics" 2269 } 2270 }, 2271 "recurrenceRule": { 2272 "frequency": "weekly", 2273 "until": "2018-06-25T09:00:00" 2274 }, 2275 "recurrenceOverrides": { 2276 "2018-01-05T14:00:00": { 2277 "title": "Introduction to Calculus I (optional)" 2278 }, 2279 "2018-04-02T09:00:00": { 2280 "excluded": "true" 2281 }, 2282 "2018-06-25T09:00:00": { 2283 "title": "Calculus I Exam", 2284 "start": "2018-06-25T10:00:00", 2285 "duration": "PT2H", 2286 "locations": { 2287 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2288 "title": "Big Auditorium", 2289 "description": "Big Auditorium, Other Road" 2290 } 2291 } 2292 } 2293 } 2294 } 2296 7.10. Recurring event with participants 2298 This example illustrates scheduled events. A team meeting occurs 2299 every week since January 8, 2018 at 9am Johannesburg time. The event 2300 owner also chairs the event. Participants meet in a virtual meeting 2301 room. An attendee has accepted the invitation, but on March 8, 2018 2302 he is unavailable and declined participation for this occurrence. 2304 { 2305 "...": "", 2306 "title": "FooBar team meeting", 2307 "start": "2018-01-08T09:00:00", 2308 "timeZone": "Africa/Johannesburg", 2309 "duration": "PT1H", 2310 "virtualLocations": { 2311 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2312 "name": "ChatMe meeting room", 2313 "uri": "https://chatme.example.com?id=1234567" 2314 } 2315 }, 2316 "recurrenceRule": { 2317 "frequency": "weekly" 2318 }, 2319 "replyTo": { 2320 "imip": "mailto:6489-4f14-a57f-c1@schedule.example.com" 2321 }, 2322 "participants": { 2323 "dG9tQGZvb2Jhci5leGFtcGxlLmNvbQ": { 2324 "name": "Tom Tool", 2325 "email": "tom@foobar.example.com", 2326 "sendTo": { 2327 "imip": "mailto:6489-4f14-a57f-c1@calendar.example.com" 2328 }, 2329 "participationStatus": "accepted", 2330 "roles": { 2331 "attendee": true 2332 } 2333 }, 2334 "em9lQGZvb2Jhci5leGFtcGxlLmNvbQ": { 2335 "name": "Zoe Zelda", 2336 "email": "zoe@foobar.example.com", 2337 "sendTo": { 2338 "imip": "mailto:zoe@foobar.example.com" 2339 }, 2340 "participationStatus": "accepted", 2341 "roles": { 2342 "owner": true, 2343 "attendee": true, 2344 "chair": true 2345 } 2346 }, 2347 "...": "" 2348 }, 2349 "recurrenceOverrides": { 2350 "2018-03-08T09:00:00": { 2351 "participants/dG9tQGZvb2Jhci5leGFtcGxlLmNvbQ/participationStatus": 2352 "declined" 2353 } 2354 } 2356 } 2358 8. Security Considerations 2360 The use of JSON as a format does have its own inherent security risks 2361 as discussed in Section 12 of [RFC8259]. Even though JSON is 2362 considered a safe subset of JavaScript, it should be kept in mind 2363 that a flaw in the parser processing JSON could still impose a 2364 threat, which doesn't arise with conventional iCalendar data. 2366 With this in mind, a parser for JSON data aware of the security 2367 implications should be used for the format described in this 2368 document. For example, the use of JavaScript's "eval()" function is 2369 considered an unacceptable security risk, as described in Section 12 2370 of[RFC8259]. A native parser with full awareness of the JSON format 2371 should be preferred. 2373 9. IANA Considerations 2375 This document amends the "application/calendar" MIME media type 2376 defined in [RFC7265]. 2378 New optional parameter: "type" with value being one of "jsevent", 2379 "jstask", "jsgroup". The parameter MUST NOT occur more than once. 2381 10. Acknowledgments 2383 The authors would like to thank the members of CalConnect for their 2384 valuable contributions. This specification originated from the work 2385 of the API technical committee of CalConnect, the Calendaring and 2386 Scheduling Consortium. 2388 11. References 2390 11.1. Normative References 2392 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2393 Requirement Levels", BCP 14, RFC 2119, 2394 DOI 10.17487/RFC2119, March 1997, 2395 . 2397 [RFC2392] Levinson, E., "Content-ID and Message-ID Uniform Resource 2398 Locators", RFC 2392, DOI 10.17487/RFC2392, August 1998, 2399 . 2401 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 2402 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 2403 . 2405 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 2406 Resource Identifier (URI): Generic Syntax", STD 66, 2407 RFC 3986, DOI 10.17487/RFC3986, January 2005, 2408 . 2410 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 2411 Unique IDentifier (UUID) URN Namespace", RFC 4122, 2412 DOI 10.17487/RFC4122, July 2005, 2413 . 2415 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data 2416 Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006, 2417 . 2419 [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault, 2420 "Calendaring Extensions to WebDAV (CalDAV)", RFC 4791, 2421 DOI 10.17487/RFC4791, March 2007, 2422 . 2424 [RFC5545] Desruisseaux, B., Ed., "Internet Calendaring and 2425 Scheduling Core Object Specification (iCalendar)", 2426 RFC 5545, DOI 10.17487/RFC5545, September 2009, 2427 . 2429 [RFC5546] Daboo, C., Ed., "iCalendar Transport-Independent 2430 Interoperability Protocol (iTIP)", RFC 5546, 2431 DOI 10.17487/RFC5546, December 2009, 2432 . 2434 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 2435 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 2436 September 2009, . 2438 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 2439 Identifier for Geographic Locations ('geo' URI)", 2440 RFC 5870, DOI 10.17487/RFC5870, June 2010, 2441 . 2443 [RFC6047] Melnikov, A., Ed., "iCalendar Message-Based 2444 Interoperability Protocol (iMIP)", RFC 6047, 2445 DOI 10.17487/RFC6047, December 2010, 2446 . 2448 [RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type 2449 Specifications and Registration Procedures", BCP 13, 2450 RFC 6838, DOI 10.17487/RFC6838, January 2013, 2451 . 2453 [RFC6901] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., 2454 "JavaScript Object Notation (JSON) Pointer", RFC 6901, 2455 DOI 10.17487/RFC6901, April 2013, 2456 . 2458 [RFC7265] Kewisch, P., Daboo, C., and M. Douglass, "jCal: The JSON 2459 Format for iCalendar", RFC 7265, DOI 10.17487/RFC7265, May 2460 2014, . 2462 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 2463 DOI 10.17487/RFC7493, March 2015, 2464 . 2466 [RFC7529] Daboo, C. and G. Yakushev, "Non-Gregorian Recurrence Rules 2467 in the Internet Calendaring and Scheduling Core Object 2468 Specification (iCalendar)", RFC 7529, 2469 DOI 10.17487/RFC7529, May 2015, 2470 . 2472 [RFC7986] Daboo, C., "New Properties for iCalendar", RFC 7986, 2473 DOI 10.17487/RFC7986, October 2016, 2474 . 2476 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 2477 Interchange Format", STD 90, RFC 8259, 2478 DOI 10.17487/RFC8259, December 2017, 2479 . 2481 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 2482 DOI 10.17487/RFC8288, October 2017, 2483 . 2485 11.2. Informative References 2487 [draft-apthorp-ical-tasks] 2488 "Task Extensions to iCalendar", 2489 . 2491 [draft-ietf-calext-ical-relations] 2492 "Support for iCalendar Relationships", 2493 . 2496 [MIME] "IANA Media Types", . 2499 11.3. URIs 2501 [1] https://www.iana.org/assignments/link-relations/link- 2502 relations.xhtml 2504 [2] https://www.w3.org/TR/2011/REC-css3-color-20110607/#svg-color 2506 [3] http://www.iana.org/time zones 2508 Authors' Addresses 2510 Neil Jenkins 2511 FastMail 2512 PO Box 234 2513 Collins St West 2514 Melbourne VIC 8007 2515 Australia 2517 Email: neilj@fastmailteam.com 2518 URI: https://www.fastmail.com 2520 Robert Stepanek 2521 FastMail 2522 PO Box 234 2523 Collins St West 2524 Melbourne VIC 8007 2525 Australia 2527 Email: rsto@fastmailteam.com 2528 URI: https://www.fastmail.com