idnits 2.17.1 draft-ietf-calext-jscalendar-00.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 (January 29, 2018) is 2277 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 2277 -- Looks like a reference, but probably isn't: '2' on line 2279 -- Looks like a reference, but probably isn't: '3' on line 2282 -- Looks like a reference, but probably isn't: '4' on line 2284 Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 5 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: August 2, 2018 January 29, 2018 7 JSCalendar: A JSON representation of calendar data 8 draft-ietf-calext-jscalendar-00 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 August 2, 2018. 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 . . . . . . . . . . . . . . . . . . . . . . . . . 5 58 2.3. JSGroup . . . . . . . . . . . . . . . . . . . . . . . . . 6 59 3. Structure of JSCalendar objects . . . . . . . . . . . . . . . 6 60 3.1. Type signatures . . . . . . . . . . . . . . . . . . . . . 6 61 3.2. Data Types . . . . . . . . . . . . . . . . . . . . . . . 6 62 3.2.1. UTCDate . . . . . . . . . . . . . . . . . . . . . . . 7 63 3.2.2. LocalDate . . . . . . . . . . . . . . . . . . . . . . 7 64 3.2.3. Duration . . . . . . . . . . . . . . . . . . . . . . 7 65 3.2.4. PatchObject . . . . . . . . . . . . . . . . . . . . . 7 66 3.2.5. Normalisation and equivalence . . . . . . . . . . . . 8 67 3.3. Custom property extensions and values . . . . . . . . . . 9 68 4. Common JSCalendar properties . . . . . . . . . . . . . . . . 9 69 4.1. Metadata properties . . . . . . . . . . . . . . . . . . . 9 70 4.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 9 71 4.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 10 72 4.1.3. relatedTo . . . . . . . . . . . . . . . . . . . . . . 10 73 4.1.4. prodId . . . . . . . . . . . . . . . . . . . . . . . 11 74 4.1.5. created . . . . . . . . . . . . . . . . . . . . . . . 11 75 4.1.6. updated . . . . . . . . . . . . . . . . . . . . . . . 11 76 4.1.7. sequence . . . . . . . . . . . . . . . . . . . . . . 11 77 4.1.8. method . . . . . . . . . . . . . . . . . . . . . . . 11 78 4.2. What and where properties . . . . . . . . . . . . . . . . 11 79 4.2.1. title . . . . . . . . . . . . . . . . . . . . . . . . 12 80 4.2.2. description . . . . . . . . . . . . . . . . . . . . . 12 81 4.2.3. htmlDescription . . . . . . . . . . . . . . . . . . . 12 82 4.2.4. locations . . . . . . . . . . . . . . . . . . . . . . 12 83 4.2.5. links . . . . . . . . . . . . . . . . . . . . . . . . 14 84 4.2.6. locale . . . . . . . . . . . . . . . . . . . . . . . 15 85 4.2.7. keywords . . . . . . . . . . . . . . . . . . . . . . 15 86 4.2.8. categories . . . . . . . . . . . . . . . . . . . . . 16 87 4.2.9. color . . . . . . . . . . . . . . . . . . . . . . . . 16 88 4.3. Recurrence properties . . . . . . . . . . . . . . . . . . 16 89 4.3.1. recurrenceRule . . . . . . . . . . . . . . . . . . . 16 90 4.3.2. recurrenceOverrides . . . . . . . . . . . . . . . . . 18 91 4.4. Sharing and scheduling properties . . . . . . . . . . . . 19 92 4.4.1. priority . . . . . . . . . . . . . . . . . . . . . . 19 93 4.4.2. freeBusyStatus . . . . . . . . . . . . . . . . . . . 19 94 4.4.3. privacy . . . . . . . . . . . . . . . . . . . . . . . 19 95 4.4.4. replyTo . . . . . . . . . . . . . . . . . . . . . . . 21 96 4.4.5. participants . . . . . . . . . . . . . . . . . . . . 22 97 4.5. Alerts properties . . . . . . . . . . . . . . . . . . . . 24 98 4.5.1. useDefaultAlerts . . . . . . . . . . . . . . . . . . 25 99 4.5.2. alerts . . . . . . . . . . . . . . . . . . . . . . . 25 100 4.6. Multilingual properties . . . . . . . . . . . . . . . . . 28 101 4.6.1. localizations . . . . . . . . . . . . . . . . . . . . 28 102 5. Type-specific JSCalendar properties . . . . . . . . . . . . . 28 103 5.1. JSEvent properties . . . . . . . . . . . . . . . . . . . 28 104 5.1.1. start . . . . . . . . . . . . . . . . . . . . . . . . 29 105 5.1.2. timeZone . . . . . . . . . . . . . . . . . . . . . . 29 106 5.1.3. duration . . . . . . . . . . . . . . . . . . . . . . 29 107 5.1.4. isAllDay . . . . . . . . . . . . . . . . . . . . . . 29 108 5.1.5. status . . . . . . . . . . . . . . . . . . . . . . . 30 109 5.2. JSTask properties . . . . . . . . . . . . . . . . . . . . 30 110 5.2.1. due . . . . . . . . . . . . . . . . . . . . . . . . . 30 111 5.2.2. start . . . . . . . . . . . . . . . . . . . . . . . . 30 112 5.2.3. timeZone . . . . . . . . . . . . . . . . . . . . . . 30 113 5.2.4. estimatedDuration . . . . . . . . . . . . . . . . . . 30 114 5.2.5. completed . . . . . . . . . . . . . . . . . . . . . . 31 115 5.2.6. isAllDay . . . . . . . . . . . . . . . . . . . . . . 31 116 5.2.7. progress . . . . . . . . . . . . . . . . . . . . . . 31 117 5.2.8. status . . . . . . . . . . . . . . . . . . . . . . . 32 118 5.3. JSGroup properties . . . . . . . . . . . . . . . . . . . 32 119 5.3.1. entries . . . . . . . . . . . . . . . . . . . . . . . 33 120 5.3.2. source . . . . . . . . . . . . . . . . . . . . . . . 33 121 6. Conversion from and to iCalendar . . . . . . . . . . . . . . 33 122 6.1. JSEvent . . . . . . . . . . . . . . . . . . . . . . . . . 33 123 6.2. JSTask . . . . . . . . . . . . . . . . . . . . . . . . . 34 124 6.3. JSGroup . . . . . . . . . . . . . . . . . . . . . . . . . 35 125 6.4. Common properties . . . . . . . . . . . . . . . . . . . . 36 126 6.5. Locations and participants . . . . . . . . . . . . . . . 38 127 6.6. Unknown properties . . . . . . . . . . . . . . . . . . . 40 128 7. JSCalendar object examples . . . . . . . . . . . . . . . . . 40 129 7.1. Simple event . . . . . . . . . . . . . . . . . . . . . . 40 130 7.2. Simple task . . . . . . . . . . . . . . . . . . . . . . . 41 131 7.3. Simple group . . . . . . . . . . . . . . . . . . . . . . 41 132 7.4. All-day event . . . . . . . . . . . . . . . . . . . . . . 42 133 7.5. Task with a due date . . . . . . . . . . . . . . . . . . 42 134 7.6. Event with end time-zone . . . . . . . . . . . . . . . . 43 135 7.7. Floating-time event (with recurrence) . . . . . . . . . . 43 136 7.8. Event with multiple locations and localization . . . . . 44 137 7.9. Recurring event with overrides . . . . . . . . . . . . . 45 138 7.10. Recurring event with participants . . . . . . . . . . . . 46 139 8. Security Considerations . . . . . . . . . . . . . . . . . . . 47 140 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 47 141 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 47 142 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 47 143 11.1. Normative References . . . . . . . . . . . . . . . . . . 47 144 11.2. Informative References . . . . . . . . . . . . . . . . . 50 145 11.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 50 147 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 50 149 1. Introduction 151 This document defines a data model for calendar event and task 152 objects, or groups of such objects, in electronic calendar 153 applications and systems. It aims to be unambiguous, extendable and 154 simple to process. 156 The key design considerations for this data model are as follows: 158 o The attributes of the calendar entry represented must be described 159 as a simple key-value pair, reducing complexity of its 160 representation. 162 o The data model should avoid all ambiguities and make it difficult 163 to make mistakes during implementation. 165 o Most of the initial set of attributes should be taken from the 166 iCalendar data format ([RFC5545], also see Section 1.1), but the 167 specification should add new attributes or value types, or not 168 support existing ones, where appropriate. Conversion between the 169 data formats need not fully preserve semantic meaning. 171 o Extensions, such as new properties and components, MUST NOT lead 172 to requiring an update to this document. 174 The representation of this data model is defined in the I-JSON format 175 [RFC7493], which is a strict subset of the JavaScript Object Notation 176 (JSON) Data Interchange Format [RFC8259]. Using JSON mostly is a 177 pragmatic choice: its widespread use should help to speed up 178 JSCalendar adoption and a wide range of production-ready JSON 179 implementations allows to decrease interoperability issues. 181 1.1. Relation to the iCalendar format 183 The iCalendar data format [RFC5545], a widely deployed interchange 184 format for calendaring and scheduling data, has served calendaring 185 vendors for a long while, but contains some ambiguities and pitfalls 186 that can not be overcome without backward-incompatible changes. 188 For example, iCalendar defines various formats for local times, UTC 189 time and dates, which confuses new users. Other sources for errors 190 are the requirement for custom time-zone definitions within a single 191 calendar component, as well as the iCalendar format itself; the 192 latter causing interoperability issues due to misuse of CR LF 193 terminated strings, line continuations and subtle differences between 194 iCalendar parsers. Lastly, up until recently the iCalendar format 195 did not allow to express the difference between two calendar 196 components, which results in verbose exchanges during scheduling. 198 Some of these issues were addressed by the jCal [RFC7265] format, 199 which is a direct mapping between iCalendar and JSON. However, it 200 did not attempt to extend or update iCalendar semantics. 202 1.2. Notational Conventions 204 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 205 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 206 document are to be interpreted as described in [RFC2119]. 208 The underlying format used for this specification is JSON. 209 Consequently, the terms "object" and "array" as well as the four 210 primitive types (strings, numbers, booleans, and null) are to be 211 interpreted as described in Section 1 of[RFC8259]. 213 Some examples in this document contain "partial" JSON documents used 214 for illustrative purposes. In these examples, three periods "..." 215 are used to indicate a portion of the document that has been removed 216 for compactness. 218 2. JSCalendar objects 220 This section describes the calendar object types specified by 221 JSCalendar. 223 2.1. JSEvent 225 MIME type: "application/calendar+json;type=jsevent" 227 A JSEvent represents a scheduled amount of time on a calendar, 228 typically a meeting, appointment, reminder or anniversary. Multiple 229 participants may partake in the event at multiple locations. 231 The @type (Section 4.1.1) property value MUST be "jsevent". 233 2.2. JSTask 235 MIME type: "application/calendar+json;type=jstask" 237 A JSTask represents an action-item, assignment, to-do or work item . 239 The @type (Section 4.1.1) property value MUST be "jstask". 241 A JSTask may start and be due at certain points in time, may take 242 some estimated time to complete and may recur; none of which is 243 required. This notably differs from JSEvent (Section 2.1) which is 244 required to start at a certain point in time and typically takes some 245 non-zero duration to complete. 247 2.3. JSGroup 249 MIME type: "application/calendar+json;type=jsgroup" 251 A JSGroup is a collection of JSEvent (Section 2.1) and JSTask 252 (Section 2.2) objects. Typically, objects are grouped by topic (e.g. 253 by keywords) or calendar membership. 255 The @type (Section 4.1.1) property value MUST be "jsgroup". 257 3. Structure of JSCalendar objects 259 A JSCalendar object is a JSON object, which MUST be valid I-JSON (a 260 stricter subset of JSON), as specified in [RFC8259]. Property names 261 and values are case-sensitive. 263 The object has a collection of properties, as specified in the 264 following sections. Unless otherwise specified, all properties are 265 optional; omitted properties MUST be treated identically to if that 266 property had the value of "null", unless otherwise specified. 268 3.1. Type signatures 270 Types signatures are given for all JSON objects in this document. 271 The following conventions are used: 273 o "Boolean|String": The value is either a JSON "Boolean" value, or a 274 JSON "String" value. 276 o "Foo": Any name that is not a native JSON type means an object for 277 which the properties (and their types) are defined elsewhere 278 within this document. 280 o "Foo[]": An array of objects of type "Foo". 282 o "String[Foo]": A JSON "Object" being used as a map (associative 283 array), where all the values are of type "Foo". 285 3.2. Data Types 287 In addition to the standard JSON data types, the following data types 288 are used in this specification: 290 3.2.1. UTCDate 292 This is a string in [RFC3339] "date-time" format, with the further 293 restrictions that any letters MUST be in upper-case, the time 294 component MUST be included and the time MUST be in UTC. Fractional 295 second values MUST NOT be included unless non-zero and MUST NOT have 296 trailing zeros, to ensure there is only a single representation for 297 each date-time. 299 For example "2010-10-10T10:10:10.003Z" is OK, but 300 "2010-10-10T10:10:10.000Z" is invalid and MUST be encoded as 301 "2010-10-10T10:10:10Z". 303 In common notation, it should be of the form "YYYY-MM-DDTHH:MM:SSZ". 305 3.2.2. LocalDate 307 This is a date-time string _with no time-zone/offset information_. 308 It is otherwise in the same format as UTCDate: "YYYY-MM-DDTHH:MM:SS". 309 The time-zone to associate the LocalDate with comes from an 310 associated property, or if no time-zone is associated it defines 311 _floating time_. Floating date-times are not tied to any specific 312 time-zone. Instead, they occur in every timezone at the same _wall- 313 clock_ time (as opposed to the same instant point in time). 315 3.2.3. Duration 317 A duration is represented by a subset of ISO8601 duration format, as 318 specified by the following ABNF: 320 dur-secfrac = "." 1*DIGIT 321 dur-second = 1*DIGIT [dur-secfrac] "S" 322 dur-minute = 1*DIGIT "M" [dur-second] 323 dur-hour = 1*DIGIT "H" [dur-minute] 324 dur-time = "T" (dur-hour / dur-minute / dur-second) 325 dur-day = 1*DIGIT "D" 327 duration = "P" (dur-day [dur-time] / dur-time) 329 In addition, the duration MUST NOT include fractional second values 330 unless the fraction is non-zero. A zero duration MUST be represented 331 as "P0D". 333 3.2.4. PatchObject 335 A *PatchObject* is of type "String[*|null]", and represents an 336 unordered set of patches on a JSON object. The keys are a path in a 337 subset of [RFC6901] JSON pointer format, with an implicit leading "/" 338 (i.e. prefix each key with "/" before applying the JSON pointer 339 evaluation algorithm). 341 A patch within a PatchObject is only valid, if all of the following 342 conditions apply: 344 1. The pointer MUST NOT reference inside an array (i.e. it MUST NOT 345 insert/delete from an array; the array MUST be replaced in its 346 entirety instead). 348 2. When evaluating a path, all parts prior to the last (i.e. the 349 value after the final slash) MUST exist. 351 3. There MUST NOT be two patches in the PatchObject where the 352 pointer of one is the prefix of the pointer of the other, e.g. 353 "alerts/1/offset" and "alerts". 355 The value associated with each pointer is either: 357 o "null": Remove the property from the patched object. If not 358 present in the parent, this a no-op. 360 o Anything else: The value to replace the inherited property on the 361 patch object with (if present) or add to the property (if not 362 present). 364 Implementations MUST reject a PatchObject if any of its patches are 365 invalid. 367 3.2.5. Normalisation and equivalence 369 JSCalendar aims to provide unambiguous definitions for value types 370 and properties, but does not define a general normalisation or 371 equivalence method for JSCalendar objects and types. This is because 372 the notion of equivalence might range from byte-level equivalence to 373 semantic equivalence, depending on the respective use case (for 374 example, the CalDAV protocol [RFC4791] requires octet equivalence of 375 the encoded calendar object to determine ETag equivalence). 377 Normalisation of JSCalendar objects is hindered because of the 378 following reasons: 380 o Custom JSCalendar properties may contain arbitrary JSON values, 381 including arrays. However, equivalence of arrays might or might 382 not depend on the order of elements, depending on the respective 383 property definition. 385 o Several JSCalendar property values are defined as URIs and MIME 386 types, but normalisation of these types is inherently protocol and 387 scheme-specific, depending on the use-case of the equivalence 388 definition (see section 6 of [RFC3986]). 390 Considering this, the definition of equivalence and normalisation is 391 left to client and server implementations and to be negotiated by a 392 calendar exchange protocol or defined by another RFC. 394 3.3. Custom property extensions and values 396 Vendors MAY add additional properties to the calendar object to 397 support their custom features. The names of these properties MUST be 398 prefixed with a domain name controlled by the vendor to avoid 399 conflict, e.g. "example.com/customprop". 401 Some JSCalendar properties allow vendor-specific value extensions. 402 If so, vendor specific values MUST be prefixed with a domain name 403 controlled by the vendor, e.g. "example.com/customrel", unless 404 otherwise noted. 406 4. Common JSCalendar properties 408 This section describes the properties that are common to the various 409 JSCalendar object types. Specific JSCalendar object types may only 410 support a subset of these properties. The object type definitions in 411 section Section 5 describe the set of supported properties per type. 413 4.1. Metadata properties 415 4.1.1. @type 417 Type: "String" 419 Specifies the type which this object represents. This MUST be one of 420 the following values, registered in a future RFC, or a vendor- 421 specific value: 423 o "jsevent": a JSCalendar event (Section 2.1). 425 o "jstask": a JSCalendar task (Section 2.2). 427 o "jsgroup": a JSCalendar group (Section 2.3). 429 A valid JSCalendar object MUST include this property. 431 4.1.2. uid 433 Type: "String" 435 A globally unique identifier, used to associate the object as the 436 same across different systems, calendars and views. The value of 437 this property MUST be unique across _all_ JSCalendar objects, even if 438 they are of different type. [RFC4122] describes a range of 439 established algorithms to generate universally unique identifiers 440 (UUID), and the random or pseudo-random version is recommended to 441 use. 443 A valid JSCalendar object MUST include this property. 445 4.1.3. relatedTo 447 Type: "String[Relation]|null" 449 Relates the object to other JSCalendar objects. This is represented 450 as a map of the uids of the related objects to information about the 451 relation. 453 A *Relation* object has the following properties: 455 o *relation*: "String[]" Describes how the linked object is related 456 to this object. 458 The strings in the array MUST each be at most one of the following 459 values, registered in a future RFC, or a vendor-specific value: 461 * "first": The linked object is the first in the series this 462 object is part of. 464 * "next": The linked object is the next in the series this object 465 is part of. 467 * "child": The linked object is a subpart of this object. 469 * "parent": This object is part of the overall linked object. 471 If an object is split to make a "this and future" change to a 472 recurrence, the original object MUST be truncated to end at the 473 previous occurrence before this split, and a new object created to 474 represent all the objects after the split. A "relation=["next"]" 475 relatedTo property MUST be set on the original object with the uid of 476 the new object. A "relation=["first"]" relatedTo property with the 477 UID of the first object in the series MUST be set on the new object. 479 Clients can then follow these UIDs to get the complete set of objects 480 if the user wishes to modify them all at once. 482 4.1.4. prodId 484 Type: "String|null" 486 The identifier for the product that created the JSCalendar object. 488 The vendor of the implementation SHOULD ensure that this is a 489 globally unique identifier, using some technique such as an FPI 490 value, as defined in [ISO.9070.1991]. 492 This property SHOULD NOT be used to alter the interpretation of an 493 JSCalendar object beyond the semantics specified in this document. 494 For example, it is not to be used to further the understanding of 495 non-standard properties. 497 4.1.5. created 499 Type: "UTCDate|null" 501 The date and time this object was initially created. 503 4.1.6. updated 505 Type: "UTCDate" 507 The date and time the data in this object was last modified. 509 4.1.7. sequence 511 Type: "Number" (Defaults to "0" if omitted) 513 Initially zero, this MUST be a non-negative integer that is 514 monotonically incremented each time a change is made to the object. 516 4.1.8. method 518 Type: "String|null" 520 The iTIP ([RFC5546]) method, in lower-case. Used for scheduling. 522 4.2. What and where properties 523 4.2.1. title 525 Type: "String" (Defaults to the empty string if omitted) 527 A short summary of the object. 529 4.2.2. description 531 Type: "String" (Defaults to the empty string if omitted) 533 A longer form description of the object. This is plain text, but a 534 client SHOULD attempt to hyperlink URLs when displaying it. 536 4.2.3. htmlDescription 538 Type: "String" (Defaults to the empty string if omitted) 540 A longer form rich-text description of the object. This is HTML text 541 [1] and allows to reference resources in the *links* property by use 542 of CID URLs (see [RFC2392]). To convert a CID URL to the *cid* 543 property value of a *Link* object, implementations MUST follow the 544 conversion described in section 2 of [RFC2392]. Implementations MAY 545 choose not to follow untrusted external CID URLs referenced in the 546 *links* property, in which case they MUST treat the *htmlDescription* 547 property as if omitted. Implementations MUST preserve the value of 548 this property, even if it contains untrusted links. 550 4.2.4. locations 552 Type: "String[Location]|null" 554 A map of location ids to Location objects, representing locations 555 associated with the object. A location id may be any string and need 556 only be unique to this object, although a UUID is a practical choice. 558 A *Location* object has the following properties. All properties are 559 optional, but every Location object MUST have at least one property: 561 o *name*: "String" The human-readable name of the location. 563 o *description*: "String" Human-readable instructions for accessing 564 this location. This may be an address, set of directions, door 565 access code, etc. 567 o *rel*: "String" The relation type of this location to the 568 JSCalendar object. 570 This MUST be either one of the following values, registered in a 571 future RFC, or a vendor-specific value. Any value the client or 572 server doesn't understand should be treated the same as "unknown". 574 * "start": The JSCalendar object starts at this location. 576 * "end": The JSCalendar object ends at this location. 578 * "virtual": This is not a physical location (e.g. this location 579 is an online chat room where people will meet). 581 * "unknown": The relation of this location to the calendar object 582 is unknown. 584 o *features*: "String[]|null" The features supported by this 585 location. 587 The strings in the array MUST each be either one of the following 588 values, registered in a future RFC, or a vendor-specific value. 589 Any value the client or server doesn't understand should be 590 ignored, but preserved. 592 The features supported by locations with rel-type "virtual" are: 594 * "audio": audio conferencing 596 * "chat": chat or instant messaging 598 * "screen": screen sharing 600 * "video": video conferencing 602 * any vendor-prefixed custom value 604 o *timeZone*: "String|null" (Defaults to "null" if omitted) A time- 605 zone for this location. 607 If "null", the *timeZone* from the JSCalendar object MUST be 608 presumed when a time-zone is needed in relation to this location. 610 o *coordinates*: "String" An [RFC5870] "geo:" URI for the location. 612 o *uri*: "String" A URI that represents how to connect to this 613 location. 615 This may be a telephone number (represented as 616 "tel:+1-555-555-555") for a teleconference, a web address for 617 online chat, or any custom URI. 619 o *linkIds*: "String[]|null" A list of ids for links to alternate 620 representations of this location. 622 For example, an alternative representation could be in vCard 623 format. If a given value does not correspond to any link id in 624 the links property of the instance, this MUST be ignored. 626 4.2.5. links 628 Type: "String[Link]|null" 630 A map of link ids to Link objects, representing external resources 631 associated with the object. A link id may be any string and need 632 only be unique to this object, although the href or a UUID are 633 practical choices. 635 A *Link* object has the following properties: 637 o *href*: "String" A URI from which the resource may be fetched. 639 This MAY be a "data:" URL, but it is recommended that the file be 640 hosted on a server to avoid embedding arbitrary large data in 641 JSCalendar object instances. 643 o *cid* "String|null" The id used within the *htmlDescription* 644 property to reference this link. 646 If not null, this MUST be a valid Content-ID MIME header value 647 (see [RFC2392]). The identifier MUST be unique within this 648 JSCalendar object but has no meaning beyond that. Specifically, 649 it MAY be different from the *Link* object identifier in the 650 enclosing *links* property. 652 o *type*: "String|null"(optional, defaults to "null") The content- 653 type [RFC6838] of the resource, if known. 655 o *size*: "Number|null"(optional, defaults to "null") The size, in 656 bytes, of the resource when fully decoded (i.e. the number of 657 bytes in the file the user would download), if known. 659 o *rel*: "String"(optional, defaults to "related") Identifies the 660 relation of the linked resource to the object. The value MUST be 661 a registered relation type (see [RFC8288] and IANA Link Relations 662 [2]). 664 Links with a rel of "enclosure" SHOULD be considered by the client 665 as attachments for download. 667 Links with a rel of "describedby" SHOULD be considered by the 668 client to be an alternate representation of the description and 669 HTML description. 671 Links with a rel of "icon" SHOULD be considered by the client to 672 be an image that it MAY use when presenting the calendar data to a 673 user. The *properties* object of this link MAY include a 674 "display" property indicating the intended purpose of this image. 675 If included, the value MUST be either one of the following values, 676 registered in a future RFC, or a vendor-specific value. 678 * "badge": an image inline with the title of the object 680 * "graphic": a full image replacement for the object itself 682 * "fullsize": an image that is used to enhance the object 684 * "thumbnail": a smaller variant of "fullsize " to be used when 685 space for the image is constrained 687 o *title*: "String|null"(optional, defaults to "null") A human- 688 readable description of the resource. 690 o *properties*: "String[String|null]|null"(optional, defaults to 691 "null") Extra metadata submitted by clients about a link. Server 692 implementations MUST preserve these properties. 694 The keys are as defined in this document, as defined in a future 695 RFC, or URIs that should be owned by the client author to avoid 696 conflicts. 698 4.2.6. locale 700 Type: "String|null" 702 The [RFC5646] language tag that best describes the locale used for 703 the calendar object, if known. 705 4.2.7. keywords 707 Type: "String[]|null" 709 A list of keywords or tags related to the object. The values are 710 free-form and do not have to follow any particular structure. 712 4.2.8. categories 714 Type: "String[]|null" 716 Specifies the categories related to the calendar object. Array 717 values MUST be URIs. In contrast to *keywords*, categories typically 718 are structured. 720 For example, a vendor owning the domain "example.com" might define 721 the categories "http://example.com/categories/sports/american- 722 football"" and "http://example.com/categories/music/r-b". 724 4.2.9. color 726 Type: "String|null" 728 Specifies a color clients MAY use when displaying this calendar 729 object. The value is a case-insensitive color name taken from the 730 CSS3 set of names, defined in Section 4.3 of W3C.REC- 731 css3-color-20110607 [3] or a CSS3 RGB color hex value. 733 4.3. Recurrence properties 735 4.3.1. recurrenceRule 737 Type: "Recurrence" 739 Defines a recurrence rule (repeating pattern) for recurring calendar 740 objects. 742 A *Recurrence* object is a JSON object mapping of a RECUR value type 743 in iCalendar, see [RFC5545] and[RFC7529]. Objects recur by applying 744 the recurrence rule (and *recurrenceOverrides*) to the *start* date/ 745 time. A JSTask (Section 2.2) without a *start* property value recurs 746 by its *due* date/time, if defined. 748 A Recurrence object has the following properties: 750 o *frequency*: "String" This MUST be one of the following values: 752 * "yearly" 754 * "monthly" 756 * "weekly" 758 * "daily" 759 * "hourly" 761 * "minutely" 763 * "secondly" 765 To convert from iCalendar, simply lower-case the FREQ part. 767 o *interval*: "Number"(optional, defaults to "1") The INTERVAL part 768 from iCal. If included, it MUST be an integer "x >= 1". 770 o *rscale*: "String"(optional, defaults to ""gregorian"") The RSCALE 771 part from iCalendar RSCALE [RFC7529], converted to lower-case. 773 o *skip*: "String"(optional, defaults to ""omit"") The SKIP part 774 from iCalendar RSCALE [RFC7529], converted to lower-case. 776 o *firstDayOfWeek*: "String"(optional, defaults to ""mo"") The WKST 777 part from iCalendar, represented as a lower-case abbreviated two- 778 letter English day of the week. If included, it MUST be one of 779 the following values: ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 781 o *byDay*: "NDay[]"(optional) An *NDay* object has the following 782 properties: 784 * *day*: "String" The day-of-the-week part of the BYDAY value in 785 iCalendar, lower-cased. MUST be one of the following values: 786 ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 788 * *nthOfPeriod*: "Number"(optional) The optional ordinal part of 789 the BYDAY value in iCalendar (e.g. ""+1"" or ""-3""). If 790 present, rather than representing every occurrence of the 791 weekday defined in the *day* property of this *NDay*, it 792 represents only a specific instance within the recurrence 793 period. The value can be positive or negative, but MUST NOT be 794 zero. A negative integer means nth-last of period. 796 o *byMonthDay*: "Number[]"(optional) The BYMONTHDAY part from 797 iCalendar. The array MUST have at least one entry if included. 799 o *byMonth*: "String[]"(optional) The BYMONTH part from iCalendar. 800 Each entry is a string representation of a number, starting from 801 "1" for the first month in the calendar (e.g. ""1" " means 802 ""January"" with Gregorian calendar), with an optional ""L"" 803 suffix (see [RFC7529]) for leap months (this MUST be upper-case, 804 e.g. ""3L""). The array MUST have at least one entry if included. 806 o *byYearDay*: "Number[]"(optional) The BYYEARDAY part from 807 iCalendar. The array MUST have at least one entry if included. 809 o *byWeekNo*: "Number[]"(optional) The BYWEEKNO part from iCalendar. 810 The array MUST have at least one entry if included. 812 o *byHour*: "Number[]"(optional) The BYHOUR part from iCalendar. 813 The array MUST have at least one entry if included. 815 o *byMinute*: "Number[]"(optional) The BYMINUTE part from iCalendar. 816 The array MUST have at least one entry if included. 818 o *bySecond*: "Number[]"(optional) The BYSECOND part from iCalendar. 819 The array MUST have at least one entry if included. 821 o *count*: "Number"(optional) The COUNT part from iCalendar. This 822 MUST NOT be included if an *until* property is specified. 824 o *until*: "LocalDate"(optional) The UNTIL part from iCalendar. 825 This MUST NOT be included if a *count* property is specified. 826 Note, as in iCalendar, this date is presumed to be in the time- 827 zone specified in *timeZone*. It is not a UTC time. 829 4.3.2. recurrenceOverrides 831 Type: "LocalDate[PatchObject|null]|null" 833 A map of the recurrence-ids (the date-time of the start of the 834 occurrence) to either "null", to indicate the occurrence should be 835 deleted, or an object of patches to apply to the generated occurrence 836 object. 838 If the recurrence-id does not match an expanded start date from a 839 recurrence rule, it is to be treated as an additional occurrence 840 (like an RDATE from iCalendar). The patch object may often be empty 841 in this case. 843 By default, an occurrence inherits all properties from the main 844 object except the start (or due) date-time, which is shifted to the 845 new start time. However, individual properties of the occurrence can 846 be modified by a patch, or multiple patches. 848 A pointer in the PatchObject MUST NOT start with one of the following 849 prefixes; any patch with such a key MUST be ignored: 851 o @type 853 o uid 854 o relatedTo 856 o prodId 858 o method 860 o isAllDay 862 o recurrenceRule 864 o recurrenceOverrides 866 o replyTo 868 4.4. Sharing and scheduling properties 870 4.4.1. priority 872 Type: "Number"(defaults to "0" if omitted) 874 Specifies a priority for the calendar object. This may be used as 875 part of scheduling systems to help resolve conflicts for a time 876 period. 878 The priority is specified as an integer in the range 0 to 9. A value 879 of 0 specifies an undefined priority. A value of 1 is the highest 880 priority. A value of 2 is the second highest priority. Subsequent 881 numbers specify a decreasing ordinal priority. A value of 9 is the 882 lowest priority. Other integer values are reserved for future use. 884 4.4.2. freeBusyStatus 886 Type: "String"(defaults to "busy" if omitted) 888 Specifies how this property should be treated when calculating free- 889 busy state. The value MUST be one of: 891 o ""free"": The object should be ignored when calculating whether 892 the user is busy. 894 o ""busy"": The object should be included when calculating whether 895 the user is busy. 897 4.4.3. privacy 899 Type: "String"(defaults to "public" if omitted) 900 Calendar objects are normally collected together and may be shared 901 with other users. The privacy property allows the object owner to 902 indicate that it should not be shared, or should only have the time 903 information shared but the details withheld. Enforcement of the 904 restrictions indicated by this property are up to the 905 implementations. 907 This property MUST NOT affect the information sent to scheduled 908 participants; it is only interpreted when the object is shared as 909 part of a shared calendar. 911 The value MUST be either one of the following values, registered in a 912 future RFC, or a vendor-specific value. Vendor specific values MUST 913 be prefixed with a domain name controlled by the vendor, e.g. 914 "example.com/topsecret". Any value the client or server doesn't 915 understand should be preserved but treated as equivalent to 916 "private". 918 o "public": The full details of the object are visible to those whom 919 the object's calendar is shared with. 921 o "private": The details of the object are hidden; only the basic 922 time and metadata is shared. Implementations MUST ensure the 923 following properties are stripped when the object is accessed by a 924 sharee: 926 * title 928 * description 930 * htmlDescription 932 * locations 934 * links 936 * locale 938 * localizations 940 * participants 942 * replyTo 944 In addition, any patches in "recurrenceOverrides" whose key is 945 prefixed with one of the above properties MUST be stripped. 947 o "secret": The object is hidden completely (as though it did not 948 exist) when the calendar is shared. 950 4.4.4. replyTo 952 Type: "String[String]|null" 954 Represents methods by which a participant may RSVP to the organizer 955 of the calendar object. The keys in the property value are the 956 available methods. The value is a URI to use that method. Future 957 methods may be defined in future specifications; a calendar client 958 MUST ignore any method it does not understand. 960 The following methods are defined: 962 o "imip": The organizer accepts an iMIP [RFC6047] response. The 963 value MUST be a "mailto:" URI. 965 o "web": There is a web page where the user may submit an RSVP using 966 their browser. The value MUST be an "http:" or "https:" URI 967 Template ([RFC6570]) in level 1 format. The template MAY contain 968 variables that MUST be expanded from the JSCalendar object as 969 defined in table Table 1. Calendar clients SHOULD be prepared to 970 handle authentication requests from the respective web page and 971 for the participant email, but this specification does not mandate 972 any specific mechanism. 974 +--------------+----------------------------------------------------+ 975 | Variable | Expand to | 976 +--------------+----------------------------------------------------+ 977 | email | The *email* property value of the replying | 978 | | *Participant* object. | 979 | | | 980 | uid | The *uid* property value of the JSCalendar object. | 981 | | | 982 | sequence | The *sequence* property value of the JSCalendar | 983 | | object. | 984 | | | 985 | recurrenceId | The recurrence-id when replying for a single | 986 | | occurrence of a recurring JSCalendar object. The | 987 | | value is the date-time of the non-overridden start | 988 | | as determined by expanding the *recurrenceRule* of | 989 | | the JSCalendar object. | 990 +--------------+----------------------------------------------------+ 992 Table 1: replyTo URI Template variables 994 4.4.5. participants 996 Type: "String[Participant]|null" 998 A map of participant ids to participants, describing their 999 participation in the calendar object. A participant id may be any 1000 string and need only be unique to this calendar object; the email 1001 address of the participant is a good choice. 1003 A *Participant* object has the following properties. Properties are 1004 mandatory unless marked otherwise: 1006 o *name*: "String" The display name of the participant (e.g. "Joe 1007 Bloggs"). 1009 o *email*: "String" The email address for the participant. 1011 o *kind*: "String"(optional, defaults to "unknown") What kind of 1012 entity this participant is. 1014 This MUST be either one of the following values, registered in a 1015 future RFC, or a vendor-specific value. Any value the client or 1016 server doesn't understand should be treated the same as "unknown". 1018 * "individual": a single person 1020 * "group": a collection of people invited as a whole 1022 * "resource": a non-human resource, e.g. a projector 1024 * "location": a physical location involved in the calendar object 1025 that needs to be scheduled, e.g. a conference room. 1027 * "unknown": no information is available about the kind of this 1028 participant. 1030 o *roles*: "String[]" A list of roles that this participant fulfils. 1032 At least one value MUST be specified for the participant. This 1033 MUST be either one of the following values, registered in a future 1034 RFC, or a vendor-specific value. Any value the client or server 1035 doesn't understand should be preserved but ignored. 1037 * "owner": The participant is an owner of the object, and allowed 1038 to make alterations to any part of it. 1040 * "attendee": The participant is an attendee of the calendar 1041 object. Attendees are only allowed to alter their own 1042 participation. 1044 * "chair": The participant is in charge of the calendar object 1045 when it occurs. 1047 o *locationId*: "String|null"(optional, defaults to "null") The 1048 location at which this participant is expected to be attending. 1050 If the value does not correspond to any location id in the 1051 locations property of the instance, this MUST be treated the same 1052 as if the participant's locationId were specified as null. 1054 o *rsvpResponse*: "String"(optional, defaults to "needs-action") The 1055 RSVP response, if any, of this participant. 1057 The value MUST be either one of the following values, registered 1058 in a future RFC, or a vendor-specific value: 1060 * "needs-action": No status yet set by the participant. 1062 * "accepted": The invited participant will participate. 1064 * "declined": The invited participant will not participate. 1066 * "tentative": The invited participant may participate. 1068 o *participation*: "String"(optional, defaults to "required") The 1069 required participation of this participant. 1071 The value MUST be either one of the following values, registered 1072 in a future RFC, or a vendor-specific value. Any value the client 1073 or server doesn't understand should be treated the same as 1074 "required". 1076 * "non-participant": Indicates a participant who is copied for 1077 information purposes only. 1079 * "optional": Indicates a participant whose participation is 1080 optional. 1082 * "required": Indicates a participant whose participation is 1083 required. 1085 o *rsvpWanted*: "Boolean"(optional, defaults to "false") If true, 1086 the organizer is expecting the participant to notify them of their 1087 status. 1089 o *scheduleSequence*: "Number"(optional, defaults to "0") The 1090 sequence number of the last response from the participant. If 1091 defined, this MUST be a non-negative integer. 1093 This can be used to determine whether the partcipant has sent a 1094 new RSVP following significant changes to the calendar object, and 1095 to determine if future responses are responding to a current or 1096 older view of the data. 1098 o *scheduleUpdated*: "UTCDate|null"(optional, defaults to "null") 1099 The *updated* property of the last iMIP response from the 1100 participant. 1102 This can be compared to the *updated* timestamp in future iMIP 1103 responses to determine if the response is older or newer than the 1104 current data. 1106 o *invitedBy*: "String|null"(optional, defaults to "null") The 1107 participant id of the participant who invited this one, if known. 1109 o *delegatedTo*: "String[]|null"(optional, defaults to "null") A 1110 list of participant ids of participants that this participant has 1111 delegated their participation to. This MUST be omitted if none 1112 (rather than an empty array). 1114 o *delegatedFrom*: "String[]|null"(optional, defaults to "null") A 1115 list of participant ids that this participant is acting as a 1116 delegate for. This MUST be omitted if none (rather than an empty 1117 array). 1119 o *memberOf*: "String[]|null"(optional, defaults to "null") A list 1120 of group participants that were invited to this calendar object, 1121 which caused this participant to be invited due to their 1122 membership of the group(s). This MUST be omitted if none (rather 1123 than an empty array). 1125 o *linkIds*: "String[]|null"(optional, defaults to "null") Links to 1126 more information about this participant, for example in vCard 1127 format. If a given value does not correspond to any link id in 1128 the links property of the instance, this id MUST be ignored. This 1129 MUST be omitted if none (rather than an empty array). 1131 4.5. Alerts properties 1132 4.5.1. useDefaultAlerts 1134 Type: "Boolean" (defaults to "false" if omitted) 1136 If "true", use the user's default alerts and ignore the value of the 1137 *alerts* property. Fetching user defaults is dependent on the API 1138 from which this JSCalendar object is being fetched, and is not 1139 defined in this specification. If an implementation cannot determine 1140 the user's default alerts, or none are set, it MUST process the 1141 alerts property as if useDefaultAlerts is set to "false". 1143 4.5.2. alerts 1145 Type: "String[Alert]|null" 1147 A map of alert ids to Alert objects, representing alerts/reminders to 1148 display or send the user for this calendar object. An alert id may 1149 be any string and need only be unique to this calendar object, 1150 although a globally unique id is a practical choice (also see 1151 Section 4.1.2)). 1153 An *Alert* Object has the following properties: 1155 o *relativeTo*: "String" (optional, defaults to "before-start") 1156 Specifies where the offset is relative to for the alarm to 1157 trigger. The value MUST be one of: 1159 * "before-start" 1161 * "after-start" 1163 * "before-end" 1165 * "after-end" 1167 o *offset*: "Duration" The offset from the start and end/due of the 1168 calendar object to fire the alert. If the calendar object does 1169 not define a time-zone, the user's default time-zone SHOULD be 1170 used when determining the offset, if known. Otherwise, the time- 1171 zone to use is implementation specific. 1173 o *action*: "DisplayAction|EmailAction|UnknownAction" 1175 Describes how to alert the user. 1177 A *DisplayAction* means a message (which is service dependent, but 1178 SHOULD include the title and start or due time of the calendar 1179 object) SHOULD be shown to the user on any client connected to 1180 this account at the specified time. How this message is formatted 1181 (and any sound or other method of drawing the user's attention) is 1182 client specific. It has the following properties: 1184 * *type*: "String" The value MUST be "display". 1186 * *acknowledged*: "UTCDate|null " (optional) 1188 When the user has permanently dismissed the alert the client 1189 MUST set this to the current time in UTC. Other clients which 1190 sync this property can then automatically dismiss or suppress 1191 duplicate alerts (alerts with the same alert id that triggered 1192 on or before this date-time). 1194 For a recurring calendar object, the *acknowledged* property of 1195 the parent object MUST be updated, unless the alert is already 1196 overridden in *recurrenceOverrides*. 1198 * *snoozed*: "UTCDate|null" (optional) 1200 If the user temporarily dismisses the alert, this is the UTC 1201 date-time after which it should be reshown. Clients displaying 1202 this alert SHOULD hide it if the snoozed property is updated to 1203 a time in the future. When that time is reached, the alert 1204 SHOULD be reshown unless acknowledged is now after the original 1205 trigger time. 1207 Setting this property on an instance of a recurring calendar 1208 object MUST update the alarm on the master object, unless the 1209 respective instance already is defined in 1210 "recurrenceOverrides". It MUST NOT generate an override for 1211 the sole use of snoozing an alarm. 1213 * *mediaLinkIds*: "String[]|null " (optional) 1215 A list of link identifiers in the JSCalendar object *links* 1216 property. Clients SHOULD play one or more of the link contents 1217 that are supported by the client implementation and are 1218 appropriate for the given device and user context. 1220 An *EmailAction* means an email SHOULD be sent as specified in the 1221 object at the specified time. It has the following properties: 1223 * *type*: "String" The value MUST be "email". 1225 * *to*: "Emailer[]" An array of name/email objects to send the 1226 alert to. 1228 An *Emailer* object has the following properties: 1230 + name: String The name of the recipient. If not known, 1231 clients SHOULD use the empty string. 1233 + email: String The email address of the recipient. 1235 * *subject*: "String" (optional) The subject to use for the 1236 email. If omitted, this is implementation specific, but the 1237 server SHOULD try to choose an appropriate subject, e.g. by 1238 including the summary. 1240 * *textBody*: "String" (optional) The plain-text body to use for 1241 the email. If omitted, the body of the email is implementation 1242 specific, but the server SHOULD include all pertinent details 1243 about the calendar object, such as summary, location and start 1244 time. 1246 * *htmlBody*: "String" (optional) The HTML body to use for the 1247 email, with rich-media content processed as for the 1248 *htmlDescription* property of the JSCalendar object (see 1249 Section 4.2.3), e.g. all CID URLs MUST be embedded in the 1250 generated alert email HTML body, or the *htmlBody* property 1251 ignored completely. If the textBody property of this alert 1252 action is not set, the server SHOULD generate a plain-text 1253 version from the HTML body and include it in a "multipart/ 1254 alternative" MIME message. 1256 * *attachments*: "String[]|null" (optional) A list of link 1257 identifiers in the JSCalendar object links property. Included 1258 attachments SHOULD be embedded in the MIME message with the 1259 "Content-Disposition" header value set to "attachment" (see 1260 [RFC2183]). Implementations MAY refuse to include one or more 1261 attachments when building an alert email, in which case they 1262 MUST ignore the contents of the *attachments* property (e.g. 1263 they MUST NOT include a subset of attachments). 1265 An *UnknownAction* object is an object that contains a *type * 1266 property whose value is not "email" or "string", plus zero or more 1267 other properties. This is for compatibility with client 1268 extensions and future RFCs. The client or server SHOULD NOT 1269 trigger any type of alert for action types they do not understand, 1270 but MUST preserve them. 1272 4.6. Multilingual properties 1274 4.6.1. localizations 1276 Type: "String[PatchObject]|null" 1278 A map of [RFC5646] language tags to patch objects, which localise the 1279 calendar object into the locale of the respective language tag. 1281 See the description of PatchObject (Section 3.2.4) for the structure 1282 of the PatchObject. The patches are applied to the top-level object 1283 and MUST only patch the following properties: 1285 o title 1287 o description 1289 o htmlDescription 1291 o keywords 1293 o Location name 1295 o Location description 1297 o Link title 1299 o EmailAction alert subject 1301 o EmailAction alert textBody 1303 o EmailAction alert htmlBody 1305 o any Link properties entry except the "display" field 1307 o any UnknownAction alert property except the "type" field 1309 o any unknown or vendor-specific property (if not defined otherwise 1310 in a future RFC or vendor-specific extension). 1312 5. Type-specific JSCalendar properties 1314 5.1. JSEvent properties 1316 In addition to the common JSCalendar object properties (Section 4) a 1317 JSEvent has the following properties: 1319 5.1.1. start 1321 Type: "LocalDate" e.g. "2015-09-02T00:00:00" 1323 The date/time the event would start in the event's time-zone. 1325 A valid JSEvent MUST include this property. 1327 5.1.2. timeZone 1329 Type: "String|null" 1331 The IANA Time Zone Database [4] name for the time-zone the event is 1332 scheduled in, or "null" for floating time. If omitted, this MUST be 1333 presumed to be "null" (i.e. floating time). 1335 5.1.3. duration 1337 Type: "Duration", e.g. "P2DT3H" (Defaults to "P0D" if omitted) 1339 The zero or positive duration of the event in absolute time (i.e. in 1340 UTC time; ignoring DST shifts). To get the end date in the event 1341 time-zone, convert start into UTC, then add the duration, then 1342 convert the result into the appropriate time-zone. 1344 A JSEvent MAY be end in a different time-zone (e.g. a plane flight 1345 crossing time-zones). In this case, the JSEvent MUST specify the end 1346 time-zone in a *location* property value that defines its *rel* to be 1347 "end" and the end time-zone in its *timeZone* property. 1349 5.1.4. isAllDay 1351 Type: "Boolean" (optional, defaults to "false") 1353 Specifies if the event an all day event, such as a birthday or public 1354 holiday. 1356 If *isAllDay* is true, then the following restrictions apply: 1358 o the *start* property MUST have a time component of "T00:00:00". 1360 o the *duration* property MUST only include a day component. 1362 Note that all-day events MAY be bound to a specific time-zone, as 1363 defined by the *timeZone* property. 1365 5.1.5. status 1367 Type: "String" 1369 The scheduling status (Section 4.4) of a JSEvent defaults to 1370 "confirmed" if omitted. 1372 If set, it MUST be one of: 1374 o "confirmed": Indicates the event is definite. 1376 o "cancelled": Indicates the event is cancelled. 1378 o "tentative": Indicates the event is tentative. 1380 5.2. JSTask properties 1382 In addition to the common JSCalendar object properties (Section 4) a 1383 JSTask has the following properties: 1385 5.2.1. due 1387 Type: "LocalDate|null" e.g. "2015-09-02T00:00:00" 1389 The date/time the task is due in the task's time-zone. 1391 5.2.2. start 1393 Type: "LocalDate|null" e.g. "2015-09-02T00:00:00" 1395 The date/time the task should start in the task's time-zone. 1397 5.2.3. timeZone 1399 Type: "String|null" 1401 The IANA Time Zone Database name for the time-zone the task is 1402 scheduled in, or "null" for floating time. If omitted, this MUST be 1403 presumed to be "null" (i.e. floating time). 1405 5.2.4. estimatedDuration 1407 Type: "Duration|null", e.g. "P2DT3H" 1409 Specifies the estimated positive duration of time the task takes to 1410 complete. 1412 If the *start* and *due* properties are set, the estimated duration 1413 SHOULD be less than or equal to the time interval between these 1414 properties. 1416 5.2.5. completed 1418 Type: "UTCDate|null", e.g. "2016-06-13T12:00:00Z" 1420 Specifies the date/time the task was completed. 1422 If the task is recurring and has future instances, a client may want 1423 to denote a specific task recurrence as completed but leave other 1424 instances as uncompleted. One way to achieve this is by overriding 1425 the completed property in the task *recurrenceOverrides*. However, 1426 this could produce a long list of completion times for regularly 1427 recurring tasks. An alternative approach is to split the JSTask into 1428 a current, single instance of JSTask with this instance completion 1429 time and a future recurring instance. Also see the definition of the 1430 *relatedTo* on splitting. 1432 5.2.6. isAllDay 1434 Type: "Boolean" (optional, defaults to "false") 1436 Specifies if the task is an all day task. 1438 If *isAllDay* is true, then the *start* and *due* properties MUST 1439 have a time component of "T00:00:00". Note that the 1440 *estimatedDuration* property MAY contain a non-zero time duration. 1441 All-day tasks MAY be bound to a specific time-zone, as defined by the 1442 *timeZone* property. 1444 5.2.7. progress 1446 In addition to the common properties of a *Participant* object 1447 (Section 4.4.5), a Participant within a JSTask supports the following 1448 property: 1450 o *progress*: "ParticipantProgress|null" The progress of the 1451 participant for this task, if known. 1453 A *ParticipantProgress* object has the following properties: 1455 o *status*: "String" Describes the completion status of the 1456 participant's progress. 1458 The value MUST be at most one of the following values, registered 1459 in a future RFC, or a vendor-specific value: 1461 * "completed": The progress of this participant is complete. 1463 * "in-process": The progress of this participant is in process. 1465 o *timestamp*: "UTCDate" Describes the latest time when the 1466 participant progress got updated. 1468 5.2.8. status 1470 Type: "String" 1472 The scheduling status (Section 4.4) of a JSTask defaults to "needs- 1473 action" if omitted. 1475 If set, it MUST be one of: 1477 o "needs-action": Indicates the task needs action. 1479 o "completed": Indicates the task is completed. If this value is 1480 set, then the timestamp in the *completed* property MUST NOT be 1481 null. 1483 o "in-process": Indicates the task is in process. 1485 o "cancelled": Indicates the task is cancelled. 1487 5.3. JSGroup properties 1489 JSGroup supports the following JSCalendar properties (Section 4): 1491 o @type 1493 o uid 1495 o created 1497 o updated 1499 o categories 1501 o keywords 1503 o name 1505 o description 1506 o htmlDescription 1508 o color 1510 o links 1512 as well as the following JSGroup-specific properties: 1514 5.3.1. entries 1516 Type: "(JSTask|JSEvent)[]|null" 1518 A list of group members. The list MAY contain multiple object types 1519 and implementations MUST ignore entries of unknown type. The 1520 property value MUST either be "null" or the list MUST NOT be empty. 1522 5.3.2. source 1524 Type: "String|null" (optional, default is "null") 1526 The source from which updated versions of this group may be retrieved 1527 from. If the value is not "null", it MUST be a URI. 1529 6. Conversion from and to iCalendar 1531 This section specifies which JSCalendar properties can be mapped from 1532 and to iCalendar format. Implementations SHOULD follow these 1533 conversion guidelines. Still, JSCalendar does not restrict itself to 1534 iCalendar and conversion between these two formats MAY be lossy. 1536 6.1. JSEvent 1538 The iCalendar counterpart to *JSEvent* is the VEVENT component type 1539 [RFC5545]. A VEVENT component that is a direct child of a VCALENDAR 1540 component is equivalent to a standalone JSEvent. A VEVENT component 1541 *within* a VEVENT maps to the entries of the JSEvent 1542 *recurrenceOverrides* property. 1544 +----------+--------------------------------------------------------+ 1545 | Property | iCalendar counterpart | 1546 +----------+--------------------------------------------------------+ 1547 | isAllDay | True, if the type of the DTSTART property in iCalendar | 1548 | | is DATE. When translating from JSCalendar the | 1549 | | iCalendar DTSTART property is of DATE value type, if | 1550 | | the *isAllDay* property is set to true and the | 1551 | | *timeZone* property is null. | 1552 | | | 1553 | start | Corresponds to the DTSTART property in iCalendar. Note | 1554 | | that time-zone information is stored separately in | 1555 | | JSEvent. | 1556 | | | 1557 | timeZone | Corresponds to the TZID part of the DTSTART property | 1558 | | in iCalendar. If the event has a different end time- | 1559 | | zone to start time-zone, this should be added as a | 1560 | | JSCalendar *location* with just a *timeZone* property | 1561 | | and "rel="end"". | 1562 | | | 1563 | duration | Corresponds to the DURATION or DSTART+DTEND properties | 1564 | | in iCalendar. | 1565 +----------+--------------------------------------------------------+ 1567 Table 2: Translation between JSEvent and iCalendar 1569 6.2. JSTask 1571 The iCalendar counterpart to *JSTask* is the VTODO component type 1572 [RFC5545]. A VTODO component that is a direct child of a VCALENDAR 1573 component is equivalent to a standalone JSTask. A VTODO component 1574 *within* a master VTODO maps to the entries of the JSTask 1575 *recurrenceOverrides* property. 1577 +-------------------+-----------------------------------------------+ 1578 | Property | iCalendar counterpart | 1579 +-------------------+-----------------------------------------------+ 1580 | isAllDay | True, if the type of the DTSTART property in | 1581 | | iCalendar is DATE. When translating from | 1582 | | JSCalendar the iCalendar DTSTART property is | 1583 | | of DATE value type, if the *isAllDay* | 1584 | | property is set to true and the *timeZone* | 1585 | | property is null. | 1586 | | | 1587 | due | Corresponds to the DUE and DTSTART+DURATION | 1588 | | properties in iCalendar. When mapping | 1589 | | iCalendar VTODOs with DTSTART+DURATION, the | 1590 | | due date is the result of adding DURATION to | 1591 | | DTSTART in the DTSTART time-zone. | 1592 | | | 1593 | start | Corresponds to the DTSTART property in | 1594 | | iCalendar. | 1595 | | | 1596 | timeZone | Corresponds to the TZID part of the | 1597 | | DTSTART/DUE properties in iCalendar. If the | 1598 | | task has a different end time-zone to start | 1599 | | or due time-zone, this should be added as a | 1600 | | JSCalendar *location* with just a *timeZone* | 1601 | | property and "rel="end"". | 1602 | | | 1603 | estimatedDuration | Corresponds to the ESTIMATED-DURATION | 1604 | | iCalendar property. *NON-STANDARD*: this | 1605 | | property is currently non-standard, see | 1606 | | [draft-apthorp-ical-tasks]. | 1607 | | | 1608 | completed | Maps to the COMPLETED iCalendar property. | 1609 | | | 1610 | progress | Corresponds to the PARTSTAT and COMPLETED | 1611 | | properties in iCalendar. | 1612 +-------------------+-----------------------------------------------+ 1614 Table 3: Translation between JSTask and iCalendar 1616 6.3. JSGroup 1618 A JSGroup converts to a iCalendar VCALENDAR containing VEVENT or 1619 VTODO components. 1621 +----------+--------------------------------------------------------+ 1622 | Property | iCalendar counterpart | 1623 +----------+--------------------------------------------------------+ 1624 | entries | The VEVENT and VTODO components within a top-level | 1625 | | VCALENDAR component. | 1626 | | | 1627 | source | Corresponds to the SOURCE property in iCalendar. | 1628 +----------+--------------------------------------------------------+ 1630 Table 4: Translation between JSGroup and iCalendar 1632 6.4. Common properties 1634 +---------------------+---------------------------------------------+ 1635 | Property | iCalendar counterpart | 1636 +---------------------+---------------------------------------------+ 1637 | alerts | An *Alert* corresponds to the VALARM | 1638 | | component in iCalendar, where the *action* | 1639 | | is determined by the iCalendar ACTION | 1640 | | property value (e.g., a "DISPLAY" property | 1641 | | indicates that the JSCalendar Alert action | 1642 | | is a *DisplayAction* and similarly an | 1643 | | iCalendar "EMAIL" value for *EmailAction* | 1644 | | action). The *relativeTo* and *offset* | 1645 | | properties corresponds to the iCalendar | 1646 | | TRIGGER property. *NON-STANDARD*: The | 1647 | | iCalendar properties for JSCalendar Alert | 1648 | | actions are non-standard, see | 1649 | | [draft-daboo-valarm-extensions]. | 1650 | | | 1651 | categories | Corresponds to the STRUCTURED-CATEGORY | 1652 | | property in iCalendar, see. *NON- | 1653 | | STANDARD*: this property is currently non- | 1654 | | standard, see | 1655 | | [draft-ietf-calext-ical-relations]. | 1656 | | | 1657 | color | Corresponds to the COLOR property in | 1658 | | iCalendar, as specified in [RFC7986]. | 1659 | | | 1660 | created | Corresponds to the CREATED property in | 1661 | | iCalendar. | 1662 | | | 1663 | description | Corresponds to the DESCRIPTION property in | 1664 | | iCalendar. | 1665 | | | 1666 | htmlDescription | There is no direct equivalent in iCalendar. | 1667 | | If the *description* is empty, | 1668 | | implementations SHOUD store a plain text | 1669 | | version of *htmlDescription* in iCalendar | 1670 | | DESCRIPTION. | 1671 | | | 1672 | freeBusyStatus | Corresponds to the TRANSP property in | 1673 | | iCalendar. | 1674 | | | 1675 | keywords | Corresponds to the CATEGORIES property in | 1676 | | iCalendar, as specified in [RFC7986]. | 1677 | | | 1678 | links | Corresponds to the ATTACH ([RFC5545]) and | 1679 | | IMAGE iCalendar properties ([RFC7986]). | 1680 | | | 1681 | locale | Corresponds to the LANGUAGE parameter in | 1682 | | iCalendar, which is added to individual | 1683 | | properties. When converting from | 1684 | | iCalendar, one language must be picked as | 1685 | | the main locale for the object, and all | 1686 | | properties in other languages moved to the | 1687 | | localizations JSEvent property. | 1688 | | | 1689 | localizations | Corresponds to the LANGUAGE parameter in | 1690 | | iCalendar, which is added to individual | 1691 | | properties. When converting from | 1692 | | iCalendar, one language must be picked as | 1693 | | the main locale for the object, and all | 1694 | | properties in other languages moved to the | 1695 | | localizations JSEvent property. | 1696 | | | 1697 | locations | See Section 6.5. | 1698 | | | 1699 | method | Corresponds to the METHOD property in | 1700 | | iCalendar. | 1701 | | | 1702 | participants | See Section 6.5. | 1703 | | | 1704 | priority | Corresponds to the PRIORITY property in | 1705 | | iCalendar. | 1706 | | | 1707 | privacy | Corresponds to the CLASS property in | 1708 | | iCalendar. | 1709 | | | 1710 | prodId | Corresponds to the PRODID property in | 1711 | | iCalendar. | 1712 | | | 1713 | recurrenceOverrides | Corresponds to the RDATE and EXDATE | 1714 | | properties in iCalendar, plus VEVENT (for | 1715 | | JSEvent) or VTODO (for JSTask) instances | 1716 | | with a recurrence-id. | 1717 | | | 1718 | recurrenceRule | Corresponds to the RRULE property in | 1719 | | iCalendar. See the property definition at | 1720 | | section Section 4.3.1 how to map a RRULE | 1721 | | value. | 1722 | | | 1723 | relatedTo | Corresponds to the RELATED-TO property in | 1724 | | iCalendar. | 1725 | | | 1726 | replyTo | A *replyTo* property of type "imip" | 1727 | | corresponds to the email address of the | 1728 | | ORGANIZER property in iCalendar. There is | 1729 | | no iCalendar representation for the "web" | 1730 | | type. | 1731 | | | 1732 | sequence | Corresponds to the SEQUENCE property in | 1733 | | iCalendar. | 1734 | | | 1735 | status | Corresponds to the STATUS property in | 1736 | | iCalendar (converted to lower-case). | 1737 | | | 1738 | title | Corresponds to the SUMMARY property in | 1739 | | iCalendar. | 1740 | | | 1741 | uid | Corresponds to the UID property in | 1742 | | iCalendar. | 1743 | | | 1744 | updated | Corresponds to the DTSTAMP and LAST- | 1745 | | MODIFIED properties in iCalendar. (These | 1746 | | are only different in the iTIP case, and | 1747 | | the difference is not actually useful.) | 1748 +---------------------+---------------------------------------------+ 1750 Table 5: Translation between JSCalendar and iCalendar 1752 6.5. Locations and participants 1754 Both JSCalendar participants and locations have counterparts in 1755 iCalendar but provide richer representation. 1757 The following table outlines translation of JSCalendar participants. 1758 Where iCalendar has distinct properties for ORGANIZER and ATTENDEE, 1759 these are merged in JSCalendar into the Participant object type. 1761 +------------------+------------------------------------------------+ 1762 | Property | iCalendar counterpart | 1763 +------------------+------------------------------------------------+ 1764 | name | the CN parameter | 1765 | | | 1766 | kind | the CUTYPE parameter | 1767 | | | 1768 | rsvpResponse | the PARTSTAT parameter | 1769 | | | 1770 | role | the ORGANIZER and ATTENDEE properties. Owners | 1771 | | map to the iCalendar ORGANIZER property, where | 1772 | | mapping multiple owners to iCalendar is | 1773 | | implementation-specific but MUST be consistent | 1774 | | across mappings of the same object. | 1775 | | | 1776 | participation | the ROLE parameter | 1777 | | | 1778 | locationId | the JSCalendar identifier of a mapped | 1779 | | CONFERENCE property that has the MODERATOR | 1780 | | feature defined in its FEATURE parameter | 1781 | | values. If multiple such CONFERENCE properties | 1782 | | are defined in iCalendar, then the one with | 1783 | | the most interactive features is chosen (VIDEO | 1784 | | over AUDIO over CHAT over anything else). | 1785 | | | 1786 | rsvpWanted | the RSVP parameter | 1787 | | | 1788 | delegatedTo | the DELEGATED-TO parameter | 1789 | | | 1790 | delegatedFrom | the DELEGATED-FROM parameter | 1791 | | | 1792 | memberOf | the MEMBER parameter | 1793 | | | 1794 | scheduleSequence | the SEQUENCE property of the participant's | 1795 | | latest iMIP message | 1796 | | | 1797 | scheduleUpdated | the DTSTAMP property of the participant's | 1798 | | latest iMIP message | 1799 +------------------+------------------------------------------------+ 1801 Table 6: Translation of Participant between JSCalendar and iCalendar 1803 For JSCalendar locations, the iCalendar counterparts are the 1804 [RFC5545] LOCATION and the extended iCalendar [RFC7986] CONFERENCE 1805 properties. 1807 An iCalendar LOCATION property becomes a JSCalendar Location with 1808 just a description property. CONFERENCE property values in iCalendar 1809 map to locations with *rel* type "virtual". The location *feature* 1810 property value corresponds to the extended iCalendar FEATURE property 1811 parameter values defined in [RFC7986]. Both iCalendar PHONE and 1812 AUDIO features map to the "audio" feature and the FEED parameter 1813 value is omitted. See the mapping for *locationId* in Table 6 on how 1814 to map CONFERENCE properties that contain the MODERATOR feature. 1816 6.6. Unknown properties 1818 Both JSCalendar and iCalendar calendar objects may contain properties 1819 that are not expressible in the other format. This specification 1820 does not mandate how to preserve these properties. Instead, it 1821 leaves negotiation on how to treat unknown properties to client and 1822 server implementations and their protocol used to exchange calendar 1823 objects. 1825 Two notable options to represent and preserve arbitrary iCalendar 1826 object properties in JSCalendar are: 1828 o *JCal*: Define iCalendar properties in JCal format ([RFC7265]) in 1829 a vendor-specific property of the JCalendar object. The JCal- 1830 formatted value may either only contain iCalendar properties that 1831 were not mapped to JSCalendar properties, or contain the complete 1832 iCalendar object representation. 1834 o *Alternate link*: Define an alternate link (Section 4.2.5) value 1835 pointing to the iCalendar representation of the JSCalendar object. 1836 E.g. the alternative representation of a VEVENT would be 1837 represented as a link with rel "alternate" and type "text/ 1838 calendar;component=VEVENT". 1840 7. JSCalendar object examples 1842 The following examples illustrate several aspects of the JSCalendar 1843 data model and format. The examples may omit mandatory or additional 1844 properties, which is indicated by a placeholder property with key 1845 "...". While most of the examples use calendar event objects, they 1846 are also illustrative for tasks. 1848 7.1. Simple event 1850 This example illustrates a simple one-time event. It specifies a 1851 one-time event that begins on January 15, 2018 at 1pm New York local 1852 time and ends after 1 hour. 1854 { 1855 "@type": "jsevent", 1856 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 1857 "updated": "2018-01-15T18:00:00Z", 1858 "title": "Some event", 1859 "start": "2018-01-15T13:00:00", 1860 "timeZone": "America/New_York", 1861 "duration": "PT1H" 1862 } 1864 7.2. Simple task 1866 This example illustrates a simple task for a plain to-do item. 1868 { 1869 "@type": "jstask", 1870 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 1871 "updated": "2018-01-15T18:00:00Z", 1872 "title": "Do something" 1873 } 1875 7.3. Simple group 1877 This example illustrates a simple calendar object group that contains 1878 an event and a task. 1880 { 1881 "@type": "jsgroup", 1882 "uid": "2a358cee-6489-4f14-a57f-c104db4dc343", 1883 "updated": "2018-01-15T18:00:00Z", 1884 "name": "A simple group", 1885 "entries": [ 1886 { 1887 "@type": "jsevent", 1888 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 1889 "updated": "2018-01-15T18:00:00Z", 1890 "title": "Some event", 1891 "start": "2018-01-15T13:00:00", 1892 "timeZone": "America/New_York", 1893 "duration": "PT1H" 1894 }, 1895 { 1896 "@type": "jstask", 1897 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 1898 "updated": "2018-01-15T18:00:00Z", 1899 "title": "Do something" 1900 } 1901 ] 1902 } 1904 7.4. All-day event 1906 This example illustrates an event for an international holiday. It 1907 specifies an all-day event on April 1 that occurs every year since 1908 the year 1900. 1910 { 1911 "...": "", 1912 "title": "April Fool's Day", 1913 "isAllDay": true, 1914 "start": "1900-04-01T00:00:00", 1915 "duration": "P1D", 1916 "recurrenceRule": { 1917 "frequency": "yearly" 1918 } 1919 } 1921 7.5. Task with a due date 1923 This example illustrates a task with a due date. It is a reminder to 1924 buy groceries before 6pm Vienna local time on January 19, 2018. The 1925 calendar user expects to need 1 hour for shopping. 1927 { 1928 "...": "", 1929 "title": "Buy groceries", 1930 "due": "2018-01-19T18:00:00", 1931 "timeZone": "Europe/Vienna", 1932 "estimatedDuration": "PT1H" 1933 } 1935 7.6. Event with end time-zone 1937 This example illustrates the use of end time-zones by use of an 1938 international flight. The flight starts on April 1, 2018 at 9am in 1939 Berlin local time. The duration of the flight is scheduled at 10 1940 hours 30 minutes. The time at the flights destination is in the same 1941 time-zone as Tokyo. Calendar clients could use the end time-zone to 1942 display the arrival time in Tokyo local time and highlight the time- 1943 zone difference of the flight. 1945 { 1946 "...": "", 1947 "title": "Flight XY51 from FRA to NRT", 1948 "start": "2018-04-01T09:00:00", 1949 "timeZone": "Europe/Berlin", 1950 "duration": "PT10H30M", 1951 "locations": { 1952 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 1953 "rel": "end", 1954 "timeZone": "Asia/Tokyo" 1955 } 1956 } 1957 } 1959 7.7. Floating-time event (with recurrence) 1961 This example illustrates the use of floating-time. Since January 1, 1962 2018, a calendar user blocks 30 minutes every day to practice Yoga at 1963 7am local time, in whatever time-zone the user is located on that 1964 date. 1966 { 1967 "...": "", 1968 "title": "Yoga", 1969 "start": "2018-01-01T07:00:00", 1970 "duration": "PT30M", 1971 "recurrenceRule": { 1972 "frequency": "daily" 1973 } 1974 } 1976 7.8. Event with multiple locations and localization 1978 This example illustrates an event that happens at both a physical and 1979 a virtual location. Fans can see a live convert on premises or 1980 online. The event title and descriptions are localized. (Note: the 1981 localization of the event description contains an UTF-8 encoded 1982 German Umlaut. This character may have been replaced with ASCII 1983 characters in the plain-text rendering of this RFC document) 1985 { 1986 "...": "", 1987 "title": "Live from Music Bowl: The Band", 1988 "description": "Go see the biggest music event ever!", 1989 "locale": "en", 1990 "start": "2018-07-04T17:00:00", 1991 "timeZone": "America/New_York", 1992 "duration": "PT3H", 1993 "locations": { 1994 "9366e041-bb4c-4aa4-b249-b4657cab925c": { 1995 "name": "The Music Bowl", 1996 "description": "Music Bowl, Central Park, New York", 1997 "coordinates": "geo:40.7829,73.9654" 1998 }, 1999 "6f3696c6-1e07-47d0-9ce1-f50014b0041a": { 2000 "name": "Free live Stream from Music Bowl", 2001 "rel": "virtual", 2002 "features": [ 2003 "video", 2004 "audio", 2005 "chat" 2006 ], 2007 "uri": "https://stream.example.com/the_band_2018" 2008 } 2009 }, 2010 "localizations": { 2011 "de": { 2012 "title": "Live von der Music Bowl: The Band!", 2013 "description": "Schau dir das groesste Musikereignis an!", 2014 "locations/6f3696c6-1e07-47d0-9ce1-f50014b0041a/name": 2015 "Gratis Live-Stream aus der Music Bowl" 2016 } 2017 } 2018 } 2020 7.9. Recurring event with overrides 2022 This example illustrates the use of recurrence overrides. A math 2023 course at a University is held for the first time on January 8, 2018 2024 at 9am London time and occurs every week until June 25, 2018. Each 2025 lecture lasts for one hour and 30 minutes and is located at the 2026 Mathematics department. This event has exceptional occurrences: at 2027 the last occurrence of the course is an exam, which lasts for 2 hours 2028 and starts at 10am. Also, the location of the exam differs from the 2029 usual location. On April 2, May 7 and May 28 no course is held. 2031 { 2032 "...": "", 2033 "title": "Calculus I", 2034 "start": "2018-01-08T09:00:00", 2035 "timeZone": "Europe/London", 2036 "duration": "PT1H30M", 2037 "locations": { 2038 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2039 "title": "Math lab room 1", 2040 "description": "Math Lab I, Department of Mathematics" 2041 } 2042 }, 2043 "recurrenceRule": { 2044 "frequency": "weekly", 2045 "until": "2018-06-25T09:00:00" 2046 }, 2047 "recurrenceOverrides": { 2048 "2018-04-02T09:00:00": null, 2049 "2018-05-07T09:00:00": null, 2050 "2018-05-28T09:00:00": null, 2051 "2018-06-25T09:00:00": { 2052 "title": "Calculus I Exam", 2053 "start": "2018-06-25T10:00:00", 2054 "duration": "PT2H", 2055 "locations": { 2056 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2057 "title": "Big Auditorium", 2058 "description": "Big Auditorium, Other Road" 2059 } 2060 } 2061 } 2062 } 2063 } 2065 7.10. Recurring event with participants 2067 This example illustrates scheduled events. A team meeting occurs 2068 every week since January 8, 2018 at 9am Johannesburg time. The event 2069 owner also chairs the event. Participants meet in a virtual meeting 2070 room. An attendee has accepted the invitation, but on March 8, 2018 2071 he is unavailable and declined participation for this occurrence. 2073 { 2074 "...": "", 2075 "title": "FooBar team meeting", 2076 "start": "2018-01-08T09:00:00", 2077 "timeZone": "Africa/Johannesburg", 2078 "duration": "PT1H", 2079 "locations": { 2080 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2081 "title": "ChatMe meeting room", 2082 "rel": "virtual", 2083 "features": [ 2084 "audio", 2085 "chat", 2086 "video" 2087 ], 2088 "uri": "https://chatme.example.com?id=1234567" 2089 } 2090 }, 2091 "recurrenceRule": { 2092 "frequency": "weekly" 2093 }, 2094 "replyTo": { 2095 "imip": "zoe@foobar.example.com" 2096 }, 2097 "participants": { 2098 "tom@foobar.example.com": { 2099 "name": "Tom Tool", 2100 "email": "tom@foobar.example.com", 2101 "rsvpResponse": "accepted", 2102 "roles": [ 2103 "attendee" 2104 ] 2105 }, 2106 "zoe@foobar.example.com": { 2107 "name": "Zoe Zelda", 2108 "email": "zoe@foobar.example.com", 2109 "rsvpResponse": "accepted", 2110 "roles": [ 2111 "owner", 2112 "chair" 2114 ] 2115 }, 2116 "...": "" 2117 }, 2118 "recurrenceOverrides": { 2119 "2018-03-08T09:00:00": { 2120 "participants/tom@foobar.example.com/rsvpResponse": "declined" 2121 } 2122 } 2123 } 2125 8. Security Considerations 2127 The use of JSON as a format does have its own inherent security risks 2128 as discussed in Section 12 of [RFC8259]. Even though JSON is 2129 considered a safe subset of JavaScript, it should be kept in mind 2130 that a flaw in the parser processing JSON could still impose a 2131 threat, which doesn't arise with conventional iCalendar data. 2133 With this in mind, a parser for JSON data aware of the security 2134 implications should be used for the format described in this 2135 document. For example, the use of JavaScript's "eval()" function is 2136 considered an unacceptable security risk, as described in Section 12 2137 of[RFC8259]. A native parser with full awareness of the JSON format 2138 should be preferred. 2140 9. IANA Considerations 2142 This document amends the "application/calendar" MIME media type 2143 defined in [RFC7265]. 2145 New optional parameter: "type" with value being one of "jsevent", 2146 "jstask", "jsgroup". The parameter MUST NOT occur more than once. 2148 10. Acknowledgments 2150 The authors would like to thank the members of CalConnect for their 2151 valuable contributions. This specification originated from the work 2152 of the API technical committee of CalConnect, the Calendaring and 2153 Scheduling Consortium. 2155 11. References 2157 11.1. Normative References 2159 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2160 Requirement Levels", BCP 14, RFC 2119, 2161 DOI 10.17487/RFC2119, March 1997, 2162 . 2164 [RFC2183] Troost, R., Dorner, S., and K. Moore, Ed., "Communicating 2165 Presentation Information in Internet Messages: The 2166 Content-Disposition Header Field", RFC 2183, 2167 DOI 10.17487/RFC2183, August 1997, 2168 . 2170 [RFC2392] Levinson, E., "Content-ID and Message-ID Uniform Resource 2171 Locators", RFC 2392, DOI 10.17487/RFC2392, August 1998, 2172 . 2174 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 2175 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 2176 . 2178 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 2179 Resource Identifier (URI): Generic Syntax", STD 66, 2180 RFC 3986, DOI 10.17487/RFC3986, January 2005, 2181 . 2183 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 2184 Unique IDentifier (UUID) URN Namespace", RFC 4122, 2185 DOI 10.17487/RFC4122, July 2005, 2186 . 2188 [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault, 2189 "Calendaring Extensions to WebDAV (CalDAV)", RFC 4791, 2190 DOI 10.17487/RFC4791, March 2007, 2191 . 2193 [RFC5545] Desruisseaux, B., Ed., "Internet Calendaring and 2194 Scheduling Core Object Specification (iCalendar)", 2195 RFC 5545, DOI 10.17487/RFC5545, September 2009, 2196 . 2198 [RFC5546] Daboo, C., Ed., "iCalendar Transport-Independent 2199 Interoperability Protocol (iTIP)", RFC 5546, 2200 DOI 10.17487/RFC5546, December 2009, 2201 . 2203 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 2204 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 2205 September 2009, . 2207 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 2208 Identifier for Geographic Locations ('geo' URI)", 2209 RFC 5870, DOI 10.17487/RFC5870, June 2010, 2210 . 2212 [RFC6047] Melnikov, A., Ed., "iCalendar Message-Based 2213 Interoperability Protocol (iMIP)", RFC 6047, 2214 DOI 10.17487/RFC6047, December 2010, 2215 . 2217 [RFC6570] Gregorio, J., Fielding, R., Hadley, M., Nottingham, M., 2218 and D. Orchard, "URI Template", RFC 6570, 2219 DOI 10.17487/RFC6570, March 2012, 2220 . 2222 [RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type 2223 Specifications and Registration Procedures", BCP 13, 2224 RFC 6838, DOI 10.17487/RFC6838, January 2013, 2225 . 2227 [RFC6901] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., 2228 "JavaScript Object Notation (JSON) Pointer", RFC 6901, 2229 DOI 10.17487/RFC6901, April 2013, 2230 . 2232 [RFC7265] Kewisch, P., Daboo, C., and M. Douglass, "jCal: The JSON 2233 Format for iCalendar", RFC 7265, DOI 10.17487/RFC7265, May 2234 2014, . 2236 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 2237 DOI 10.17487/RFC7493, March 2015, 2238 . 2240 [RFC7529] Daboo, C. and G. Yakushev, "Non-Gregorian Recurrence Rules 2241 in the Internet Calendaring and Scheduling Core Object 2242 Specification (iCalendar)", RFC 7529, 2243 DOI 10.17487/RFC7529, May 2015, 2244 . 2246 [RFC7986] Daboo, C., "New Properties for iCalendar", RFC 7986, 2247 DOI 10.17487/RFC7986, October 2016, 2248 . 2250 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 2251 Interchange Format", STD 90, RFC 8259, 2252 DOI 10.17487/RFC8259, December 2017, 2253 . 2255 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 2256 DOI 10.17487/RFC8288, October 2017, 2257 . 2259 11.2. Informative References 2261 [draft-apthorp-ical-tasks] 2262 "Task Extensions to iCalendar", 2263 . 2265 [draft-daboo-valarm-extensions] 2266 "VALARM Extensions for iCalendar", 2267 . 2270 [draft-ietf-calext-ical-relations] 2271 "Support for iCalendar Relationships", 2272 . 2275 11.3. URIs 2277 [1] https://www.w3.org/TR/html/ 2279 [2] https://www.iana.org/assignments/link-relations/link- 2280 relations.xhtml 2282 [3] https://www.w3.org/TR/2011/REC-css3-color-20110607/#svg-color 2284 [4] http://www.iana.org/time-zones 2286 Authors' Addresses 2288 Neil Jenkins 2289 FastMail 2290 PO Box 234 2291 Collins St West 2292 Melbourne VIC 8007 2293 Australia 2295 Email: neilj@fastmailteam.com 2296 URI: https://www.fastmail.com 2297 Robert Stepanek 2298 FastMail 2299 PO Box 234 2300 Collins St West 2301 Melbourne VIC 8007 2302 Australia 2304 Email: rsto@fastmailteam.com 2305 URI: https://www.fastmail.com