idnits 2.17.1 draft-ietf-calext-jscalendar-15.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 (June 17, 2019) is 1747 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 2299 == Missing Reference: 'Relation' is mentioned on line 498, but not defined == Missing Reference: 'Boolean' is mentioned on line 1598, but not defined == Missing Reference: 'Location' is mentioned on line 605, but not defined == Missing Reference: 'VirtualLocation' is mentioned on line 650, but not defined == Missing Reference: 'Link' is mentioned on line 674, but not defined -- Looks like a reference, but probably isn't: '2' on line 2301 -- Looks like a reference, but probably isn't: '3' on line 2304 == Missing Reference: 'PatchObject' is mentioned on line 1479, but not defined == Missing Reference: 'String' is mentioned on line 1243, but not defined == Missing Reference: 'Participant' is mentioned on line 1228, but not defined == Missing Reference: 'Alert' is mentioned on line 1403, but not defined == Missing Reference: 'TimeZone' is mentioned on line 1532, but not defined Summary: 0 errors (**), 0 flaws (~~), 11 warnings (==), 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: December 19, 2019 June 17, 2019 7 JSCalendar: A JSON representation of calendar data 8 draft-ietf-calext-jscalendar-15 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. In contrast to the JSON-based jCal 17 format, it is not a direct mapping from iCalendar and expands 18 semantics where appropriate. 20 Status of This Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at https://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on December 19, 2019. 37 Copyright Notice 39 Copyright (c) 2019 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents 44 (https://trustee.ietf.org/license-info) in effect on the date of 45 publication of this document. Please review these documents 46 carefully, as they describe your rights and restrictions with respect 47 to this document. Code Components extracted from this document must 48 include Simplified BSD License text as described in Section 4.e of 49 the Trust Legal Provisions and are provided without warranty as 50 described in the Simplified BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 55 1.1. Relation to the iCalendar format . . . . . . . . . . . . 4 56 1.2. Relation to the jCal format . . . . . . . . . . . . . . . 5 57 1.3. Notational Conventions . . . . . . . . . . . . . . . . . 5 58 2. JSCalendar objects . . . . . . . . . . . . . . . . . . . . . 5 59 2.1. JSEvent . . . . . . . . . . . . . . . . . . . . . . . . . 5 60 2.2. JSTask . . . . . . . . . . . . . . . . . . . . . . . . . 6 61 2.3. JSGroup . . . . . . . . . . . . . . . . . . . . . . . . . 6 62 3. Structure of JSCalendar objects . . . . . . . . . . . . . . . 6 63 3.1. Type signatures . . . . . . . . . . . . . . . . . . . . . 6 64 3.2. Data Types . . . . . . . . . . . . . . . . . . . . . . . 7 65 3.2.1. UTCDate . . . . . . . . . . . . . . . . . . . . . . . 7 66 3.2.2. LocalDate . . . . . . . . . . . . . . . . . . . . . . 7 67 3.2.3. Duration . . . . . . . . . . . . . . . . . . . . . . 7 68 3.2.4. PatchObject . . . . . . . . . . . . . . . . . . . . . 8 69 3.2.5. Identifiers . . . . . . . . . . . . . . . . . . . . . 9 70 3.2.6. Time Zones . . . . . . . . . . . . . . . . . . . . . 9 71 3.2.7. Normalization and equivalence . . . . . . . . . . . . 9 72 3.3. Custom property extensions and values . . . . . . . . . . 10 73 4. Common JSCalendar properties . . . . . . . . . . . . . . . . 10 74 4.1. Metadata properties . . . . . . . . . . . . . . . . . . . 10 75 4.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 10 76 4.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 11 77 4.1.3. relatedTo . . . . . . . . . . . . . . . . . . . . . . 11 78 4.1.4. prodId . . . . . . . . . . . . . . . . . . . . . . . 12 79 4.1.5. created . . . . . . . . . . . . . . . . . . . . . . . 12 80 4.1.6. updated . . . . . . . . . . . . . . . . . . . . . . . 12 81 4.1.7. sequence . . . . . . . . . . . . . . . . . . . . . . 12 82 4.1.8. method . . . . . . . . . . . . . . . . . . . . . . . 13 83 4.2. What and where properties . . . . . . . . . . . . . . . . 13 84 4.2.1. title . . . . . . . . . . . . . . . . . . . . . . . . 13 85 4.2.2. description . . . . . . . . . . . . . . . . . . . . . 13 86 4.2.3. descriptionContentType . . . . . . . . . . . . . . . 13 87 4.2.4. locations . . . . . . . . . . . . . . . . . . . . . . 13 88 4.2.5. virtualLocations . . . . . . . . . . . . . . . . . . 14 89 4.2.6. links . . . . . . . . . . . . . . . . . . . . . . . . 15 90 4.2.7. locale . . . . . . . . . . . . . . . . . . . . . . . 16 91 4.2.8. keywords . . . . . . . . . . . . . . . . . . . . . . 16 92 4.2.9. categories . . . . . . . . . . . . . . . . . . . . . 16 93 4.2.10. color . . . . . . . . . . . . . . . . . . . . . . . . 17 94 4.3. Recurrence properties . . . . . . . . . . . . . . . . . . 17 95 4.3.1. recurrenceRule . . . . . . . . . . . . . . . . . . . 17 96 4.3.2. recurrenceOverrides . . . . . . . . . . . . . . . . . 23 97 4.3.3. excluded . . . . . . . . . . . . . . . . . . . . . . 24 98 4.4. Sharing and scheduling properties . . . . . . . . . . . . 24 99 4.4.1. priority . . . . . . . . . . . . . . . . . . . . . . 24 100 4.4.2. freeBusyStatus . . . . . . . . . . . . . . . . . . . 24 101 4.4.3. privacy . . . . . . . . . . . . . . . . . . . . . . . 25 102 4.4.4. replyTo . . . . . . . . . . . . . . . . . . . . . . . 26 103 4.4.5. participants . . . . . . . . . . . . . . . . . . . . 26 104 4.5. Alerts properties . . . . . . . . . . . . . . . . . . . . 30 105 4.5.1. useDefaultAlerts . . . . . . . . . . . . . . . . . . 30 106 4.5.2. alerts . . . . . . . . . . . . . . . . . . . . . . . 30 107 4.6. Multilingual properties . . . . . . . . . . . . . . . . . 32 108 4.6.1. localizations . . . . . . . . . . . . . . . . . . . . 32 109 4.7. Time zone properties . . . . . . . . . . . . . . . . . . 33 110 4.7.1. timeZones . . . . . . . . . . . . . . . . . . . . . . 33 111 5. Type-specific JSCalendar properties . . . . . . . . . . . . . 34 112 5.1. JSEvent properties . . . . . . . . . . . . . . . . . . . 34 113 5.1.1. start . . . . . . . . . . . . . . . . . . . . . . . . 35 114 5.1.2. timeZone . . . . . . . . . . . . . . . . . . . . . . 35 115 5.1.3. duration . . . . . . . . . . . . . . . . . . . . . . 35 116 5.1.4. isAllDay . . . . . . . . . . . . . . . . . . . . . . 35 117 5.1.5. status . . . . . . . . . . . . . . . . . . . . . . . 36 118 5.2. JSTask properties . . . . . . . . . . . . . . . . . . . . 36 119 5.2.1. due . . . . . . . . . . . . . . . . . . . . . . . . . 36 120 5.2.2. start . . . . . . . . . . . . . . . . . . . . . . . . 36 121 5.2.3. timeZone . . . . . . . . . . . . . . . . . . . . . . 36 122 5.2.4. estimatedDuration . . . . . . . . . . . . . . . . . . 36 123 5.2.5. statusUpdatedAt . . . . . . . . . . . . . . . . . . . 37 124 5.2.6. progress . . . . . . . . . . . . . . . . . . . . . . 37 125 5.2.7. status . . . . . . . . . . . . . . . . . . . . . . . 38 126 5.3. JSGroup properties . . . . . . . . . . . . . . . . . . . 38 127 5.3.1. entries . . . . . . . . . . . . . . . . . . . . . . . 39 128 5.3.2. source . . . . . . . . . . . . . . . . . . . . . . . 39 129 6. JSCalendar object examples . . . . . . . . . . . . . . . . . 39 130 6.1. Simple event . . . . . . . . . . . . . . . . . . . . . . 39 131 6.2. Simple task . . . . . . . . . . . . . . . . . . . . . . . 40 132 6.3. Simple group . . . . . . . . . . . . . . . . . . . . . . 40 133 6.4. All-day event . . . . . . . . . . . . . . . . . . . . . . 41 134 6.5. Task with a due date . . . . . . . . . . . . . . . . . . 41 135 6.6. Event with end time-zone . . . . . . . . . . . . . . . . 42 136 6.7. Floating-time event (with recurrence) . . . . . . . . . . 42 137 6.8. Event with multiple locations and localization . . . . . 43 138 6.9. Recurring event with overrides . . . . . . . . . . . . . 44 139 6.10. Recurring event with participants . . . . . . . . . . . . 45 140 7. Security Considerations . . . . . . . . . . . . . . . . . . . 47 141 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 47 142 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 48 143 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 48 144 10.1. Normative References . . . . . . . . . . . . . . . . . . 48 145 10.2. Informative References . . . . . . . . . . . . . . . . . 50 146 10.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 51 147 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 51 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] and [RFC7986], also see 167 Section 1.1), but the specification should add new attributes or 168 value types, or not support existing ones, where appropriate. 169 Conversion between the data formats need not fully preserve 170 semantic meaning. 172 o Extensions, such as new properties and components, MUST NOT lead 173 to requiring an update to this document. 175 The representation of this data model is defined in the I-JSON format 176 [RFC7493], which is a strict subset of the JavaScript Object Notation 177 (JSON) Data Interchange Format [RFC8259]. Using JSON is mostly a 178 pragmatic choice: its widespread use makes JSCalendar easier to 179 adopt, and the ready availability of production-ready JSON 180 implementations eliminates a whole category of parser-related 181 interoperability issues. 183 1.1. Relation to the iCalendar format 185 The iCalendar data format [RFC5545], a widely deployed interchange 186 format for calendaring and scheduling data, has served calendaring 187 vendors for a long while, but contains some ambiguities and pitfalls 188 that can not be overcome without backward-incompatible changes. 190 For example, iCalendar defines various formats for local times, UTC 191 time and dates, which confuses new users. Other sources for errors 192 are the requirement for custom time zone definitions within a single 193 calendar component, as well as the iCalendar format itself; the 194 latter causing interoperability issues due to misuse of CR LF 195 terminated strings, line continuations and subtle differences between 196 iCalendar parsers. Lastly, up until recently the iCalendar format 197 did not have a way to express a concise difference between two 198 calendar components, which results in verbose exchanges during 199 scheduling. 201 1.2. Relation to the jCal format 203 The JSON format for iCalendar data, jCal [RFC7265], is a direct 204 mapping between iCalendar and JSON. It does not attempt to extend or 205 update iCalendar semantics, and consequently does not address the 206 issues outlined in Section 1.1. 208 Since the standardization of jCal, the majority of implementations 209 and service providers either kept using iCalendar, or came up with 210 their own proprietary JSON representation, which often are 211 incompatible with each other. JSCalendar is intended to meet this 212 demand for JSON formatted calendar data, and to provide a standard 213 representation as an alternative to new proprietary formats. 215 1.3. Notational Conventions 217 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 218 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 219 document are to be interpreted as described in [RFC2119]. 221 The underlying format used for this specification is JSON. 222 Consequently, the terms "object" and "array" as well as the four 223 primitive types (strings, numbers, booleans, and null) are to be 224 interpreted as described in Section 1 of [RFC8259]. 226 Some examples in this document contain "partial" JSON documents used 227 for illustrative purposes. In these examples, three periods "..." 228 are used to indicate a portion of the document that has been removed 229 for compactness. 231 2. JSCalendar objects 233 This section describes the calendar object types specified by 234 JSCalendar. 236 2.1. JSEvent 238 MIME type: "application/jscalendar+json;type=jsevent" 239 A JSEvent represents a scheduled amount of time on a calendar, 240 typically a meeting, appointment, reminder or anniversary. Multiple 241 participants may partake in the event at multiple locations. 243 The @type (Section 4.1.1) property value MUST be "jsevent". 245 2.2. JSTask 247 MIME type: "application/jscalendar+json;type=jstask" 249 A JSTask represents an action-item, assignment, to-do or work item . 251 The @type (Section 4.1.1) property value MUST be "jstask". 253 A JSTask may start and be due at certain points in time, may take 254 some estimated time to complete and may recur; none of which is 255 required. This notably differs from JSEvent (Section 2.1) which is 256 required to start at a certain point in time and typically takes some 257 non-zero duration to complete. 259 2.3. JSGroup 261 MIME type: "application/jscalendar+json;type=jsgroup" 263 A JSGroup is a collection of JSEvent (Section 2.1) and JSTask 264 (Section 2.2) objects. Typically, objects are grouped by topic (e.g. 265 by keywords) or calendar membership. 267 The @type (Section 4.1.1) property value MUST be "jsgroup". 269 3. Structure of JSCalendar objects 271 A JSCalendar object is a JSON object, which MUST be valid I-JSON (a 272 stricter subset of JSON), as specified in [RFC8259]. Property names 273 and values are case-sensitive. 275 The object has a collection of properties, as specified in the 276 following sections. Properties are specified as being either 277 mandatory or optional. Optional properties may have a default value, 278 if explicitly specified in the property definition. 280 3.1. Type signatures 282 Types signatures are given for all JSON objects in this document. 283 The following conventions are used: 285 o "Boolean|String": The value is either a JSON "Boolean" value, or a 286 JSON "String" value. 288 o "Foo": Any name that is not a native JSON type means an object for 289 which the properties (and their types) are defined elsewhere 290 within this document. 292 o "Foo[]": An array of objects of type "Foo". 294 o "String[Foo]": A JSON "Object" being used as a map (associative 295 array), where all the values are of type "Foo". 297 3.2. Data Types 299 In addition to the standard JSON data types, the following data types 300 are used in this specification: 302 3.2.1. UTCDate 304 This is a string in [RFC3339] "date-time" format, with the further 305 restrictions that any letters MUST be in upper-case, the time 306 component MUST be included and the time MUST be in UTC. Fractional 307 second values MUST NOT be included unless non-zero and MUST NOT have 308 trailing zeros, to ensure there is only a single representation for 309 each date-time. 311 For example "2010-10-10T10:10:10.003Z" is OK, but 312 "2010-10-10T10:10:10.000Z" is invalid and MUST be encoded as 313 "2010-10-10T10:10:10Z". 315 In common notation, it should be of the form "YYYY-MM-DDTHH:MM:SSZ". 317 3.2.2. LocalDate 319 This is a date-time string _with no time zone/offset information_. 320 It is otherwise in the same format as UTCDate, including fractional 321 seconds. For example "2006-01-02T15:04:05" and 322 "2006-01-02T15:04:05.003" are both valid. The time zone to associate 323 the LocalDate with comes from an associated property, or if no time 324 zone is associated it defines _floating time_. Floating date-times 325 are not tied to any specific time zone. Instead, they occur in every 326 time zone at the same wall-clock time (as opposed to the same instant 327 point in time). 329 3.2.3. Duration 331 A Duration object is represented by a subset of ISO8601 duration 332 format, as specified by the following ABNF: 334 dur-secfrac = "." 1*DIGIT 335 dur-second = 1*DIGIT [dur-secfrac] "S" 336 dur-minute = 1*DIGIT "M" [dur-second] 337 dur-hour = 1*DIGIT "H" [dur-minute] 338 dur-time = "T" (dur-hour / dur-minute / dur-second) 339 dur-day = 1*DIGIT "D" 340 dur-week = 1*DIGIT "W" 342 duration = "P" (dur-day [dur-time] / dur-time / dur-week) 344 In addition, the duration MUST NOT include fractional second values 345 unless the fraction is non-zero. 347 A SignedDuration object is represented as a duration, optionally 348 preceeded by a sign character. It typically is used to express the 349 offset of a point in time relative to an associated time. It is 350 specified by the following ABNF: 352 signed-duration = (["+"] / "-") duration 354 A negative sign indicates a point in time at or before the associated 355 time, a positive or no sign a time at or after the associated time. 357 3.2.4. PatchObject 359 A PatchObject is of type "String[*|null]", and represents an 360 unordered set of patches on a JSON object. The keys are a path in a 361 subset of [RFC6901] JSON pointer format, with an implicit leading "/" 362 (i.e. prefix each key with "/" before applying the JSON pointer 363 evaluation algorithm). 365 A patch within a PatchObject is only valid, if all of the following 366 conditions apply: 368 1. The pointer MUST NOT reference inside an array (i.e. it MUST NOT 369 insert/delete from an array; the array MUST be replaced in its 370 entirety instead). 372 2. When evaluating a path, all parts prior to the last (i.e. the 373 value after the final slash) MUST exist. 375 3. There MUST NOT be two patches in the PatchObject where the 376 pointer of one is the prefix of the pointer of the other, e.g. 377 "alerts/foo/offset" and "alerts". 379 The value associated with each pointer is either: 381 o "null": Remove the property from the patched object. If not 382 present in the parent, this a no-op. 384 o Anything else: The value to replace the inherited property on the 385 patch object with (if present) or add to the property (if not 386 present). 388 Implementations MUST reject a PatchObject if any of its patches are 389 invalid. 391 3.2.5. Identifiers 393 If not stated otherwise in the respective property definition, 394 properties and object keys that define identifiers MUST be string 395 values, MUST be at least 1 character and maximum 256 characters in 396 size, and MUST only contain characters from the "URL and Filename 397 safe" Base 64 Alphabet, as defined in section 5 of [RFC4648]. This 398 is the ASCII alphanumeric characters (A-Za-z0-9), hyphen (-), and 399 underscore (_). Note that [RFC7493] requires string values be 400 encoded in UTF-8, so the maximum size of an identifier according to 401 this definition is 256 octets. 403 . Identifiers in object maps need not be universally unique, e.g. two 404 calendar objects MAY use the same identifiers in their respective 405 "links" properties. 407 Nevertheless, a UUID typically is a good choice. 409 3.2.6. Time Zones 411 By default, time zones in JSCalendar are identified by their name in 412 the IANA Time Zone Database [1], and the zone rules of the respective 413 zone record apply. 415 Implementations MAY embed the definition of custom time zones in the 416 "timeZones" property (see Section 4.7.1). 418 3.2.7. Normalization and equivalence 420 JSCalendar aims to provide unambiguous definitions for value types 421 and properties, but does not define a general normalization or 422 equivalence method for JSCalendar objects and types. This is because 423 the notion of equivalence might range from byte-level equivalence to 424 semantic equivalence, depending on the respective use case (for 425 example, the CalDAV protocol [RFC4791] requires octet equivalence of 426 the encoded calendar object to determine ETag equivalence). 428 Normalization of JSCalendar objects is hindered because of the 429 following reasons: 431 o Custom JSCalendar properties may contain arbitrary JSON values, 432 including arrays. However, equivalence of arrays might or might 433 not depend on the order of elements, depending on the respective 434 property definition. 436 o Several JSCalendar property values are defined as URIs and MIME 437 types, but normalization of these types is inherently protocol and 438 scheme-specific, depending on the use-case of the equivalence 439 definition (see section 6 of [RFC3986]). 441 Considering this, the definition of equivalence and normalization is 442 left to client and server implementations and to be negotiated by a 443 calendar exchange protocol or defined by another RFC. 445 3.3. Custom property extensions and values 447 Vendors MAY add additional properties to the calendar object to 448 support their custom features. The names of these properties MUST be 449 prefixed with a domain name controlled by the vendor to avoid 450 conflict, e.g. "example.com/customprop". 452 Some JSCalendar properties allow vendor-specific value extensions. 453 If so, vendor specific values MUST be prefixed with a domain name 454 controlled by the vendor, e.g. "example.com/customrel", unless 455 otherwise noted. 457 4. Common JSCalendar properties 459 This section describes the properties that are common to the various 460 JSCalendar object types. Specific JSCalendar object types may only 461 support a subset of these properties. The object type definitions in 462 Section 5 describe the set of supported properties per type. 464 4.1. Metadata properties 466 4.1.1. @type 468 Type: String (mandatory). 470 Specifies the type which this object represents. This MUST be one of 471 the following values, registered in a future RFC, or a vendor- 472 specific value: 474 o "jsevent": a JSCalendar event (Section 2.1). 476 o "jstask": a JSCalendar task (Section 2.2). 478 o "jsgroup": a JSCalendar group (Section 2.3). 480 4.1.2. uid 482 Type: String (mandatory). 484 A globally unique identifier, used to associate the object as the 485 same across different systems, calendars and views. The value of 486 this property MUST be unique across all JSCalendar objects, even if 487 they are of different type. [RFC4122] describes a range of 488 established algorithms to generate universally unique identifiers 489 (UUID), and the random or pseudo-random version is recommended. 491 For compatibility with [RFC5545] UIDs, implementations MUST be able 492 to receive and persist values of at least 255 octets for this 493 property, but they MUST NOT truncate values in the middle of a UTF-8 494 multi-octet sequence. 496 4.1.3. relatedTo 498 Type: String[Relation] (optional). 500 Relates the object to other JSCalendar objects. This is represented 501 as a map of the UIDs of the related objects to information about the 502 relation. 504 A Relation object has the following properties: 506 o relation: String[Boolean] (optional). Describes how the linked 507 object is related to this object as a set of relation types. If 508 not null, the set MUST NOT be empty. 510 Keys in the set MUST be one of the following values, defined in a 511 future specification or a vendor-specific value: 513 * "first": The linked object is the first in the series this 514 object is part of. 516 * "next": The linked object is the next in the series this object 517 is part of. 519 * "child": The linked object is a subpart of this object. 521 * "parent": This object is part of the overall linked object. 523 The value for each key in the set MUST be "true". 525 If an object is split to make a "this and future" change to a 526 recurrence, the original object MUST be truncated to end at the 527 previous occurrence before this split, and a new object created to 528 represent all the objects after the split. A "next" relation MUST be 529 set on the original object's relatedTo property for the UID of the 530 new object. A "first" relation for the UID of the first object in 531 the series MUST be set on the new object. Clients can then follow 532 these UIDs to get the complete set of objects if the user wishes to 533 modify them all at once. 535 4.1.4. prodId 537 Type: String (optional). 539 The identifier for the product that created the JSCalendar object. 541 The vendor of the implementation SHOULD ensure that this is a 542 globally unique identifier, using some technique such as an FPI 543 value, as defined in [ISO.9070.1991]. It MUST only use characters of 544 an iCalendar TEXT data value (see section 3.3.11 in [RFC5545]). 546 This property SHOULD NOT be used to alter the interpretation of an 547 JSCalendar object beyond the semantics specified in this document. 548 For example, it is not to be used to further the understanding of 549 non-standard properties. 551 4.1.5. created 553 Type: UTCDate (optional). 555 The date and time this object was initially created. 557 4.1.6. updated 559 Type: UTCDate (mandatory). 561 The date and time the data in this object was last modified. 563 4.1.7. sequence 565 Type: Number (optional, default: "0"). 567 Initially zero, this MUST be a non-negative integer that is 568 monotonically incremented each time a change is made to the object. 570 4.1.8. method 572 Type: String (optional). 574 The iTIP ([RFC5546]) method, in lower-case. Used for scheduling. 576 4.2. What and where properties 578 4.2.1. title 580 Type: String (optional, default: empty String). 582 A short summary of the object. 584 4.2.2. description 586 Type: String (optional, default: empty String). 588 A longer-form text description of the object. The content is 589 formatted according to the "descriptionContentType" property. 591 4.2.3. descriptionContentType 593 Type: String (optional, default: "text/plain"). 595 Describes the media type ([RFC6838]) of the contents of the 596 "description" property. Media types MUST be sub-types of type 597 "text", and SHOULD be "text/plain" or "text/html" ([MIME]). They MAY 598 define parameters and the "charset" parameter value MUST be "utf-8", 599 if specified. Descriptions of type "text/html" MAY contain "cid" 600 URLs ([RFC2392]) to reference links in the calendar object by use of 601 the "cid" property of the Link object. 603 4.2.4. locations 605 Type: String[Location] (optional). 607 A map of location identifiers to Location objects, representing 608 locations associated with the object. 610 A Location object has the following properties. It must define at 611 least one other property than the "relativeTo" property. 613 o name: String (optional, default: empty String). The human- 614 readable name of the location. 616 o description: String (optional). Human-readable, plain-text 617 instructions for accessing this location. This may be an address, 618 set of directions, door access code, etc. 620 o relativeTo: String (optional). The relation type of this location 621 to the JSCalendar object. 623 This MUST be either one of the following values, registered in a 624 future RFC, or a vendor-specific value. Any value the client or 625 server doesn't understand should be treated the same as if this 626 property is omitted. 628 * "start": The JSCalendar object starts at this location. 630 * "end": The JSCalendar object ends at this location. 632 o timeZone: String (optional). A time zone for this location. Also 633 see Section 3.2.6. 635 o coordinates: String (optional). An [RFC5870] "geo:" URI for the 636 location. 638 o linkIds: String[Boolean] (optional). A set of link ids for links 639 to alternate representations of this location. Each key in the 640 set MUST be the identifier of a Link object defined in the "links" 641 property of this calendar object. The value for each key in the 642 set MUST be "true". This MUST be omitted if none (rather than an 643 empty set). 645 For example, an alternative representation could be in vCard 646 format. 648 4.2.5. virtualLocations 650 Type: String[VirtualLocation] (optional). 652 A map of identifiers to VirtualLocation objects, representing virtual 653 locations, such as video conferences or chat rooms, associated with 654 the object. 656 A VirtualLocation object has the following properties. 658 o name: String (optional, default: empty String). The human- 659 readable name of the virtual location. 661 o description: String (optional). Human-readable plain-text 662 instructions for accessing this location. This may be an address, 663 set of directions, door access code, etc. 665 o uri: String (mandatory). A URI that represents how to connect to 666 this virtual location. 668 This may be a telephone number (represented as 669 "tel:+1-555-555-555") for a teleconference, a web address for 670 online chat, or any custom URI. 672 4.2.6. links 674 Type: String[Link] (optional). 676 A map of link identifiers to Link objects, representing external 677 resources associated with the object. 679 A Link object has the following properties: 681 o href: String (mandatory). A URI from which the resource may be 682 fetched. 684 This MAY be a "data:" URL, but it is recommended that the file be 685 hosted on a server to avoid embedding arbitrarily large data in 686 JSCalendar object instances. 688 o cid: String (optional). This MUST be a valid "content-id" value 689 according to the definition of section 2 in [RFC2392]. The 690 identifier MUST be unique within this JSCalendar object Link 691 objects but has no meaning beyond that. Specifically, it MAY be 692 different from the link identifier in the enclosing "links" 693 property. 695 o type: String (optional). The content-type [RFC6838] of the 696 resource, if known. 698 o size: Number (optional). The size, in bytes, of the resource when 699 fully decoded (i.e. the number of bytes in the file the user would 700 download), if known. 702 o rel: String (optional). Identifies the relation of the linked 703 resource to the object. If set, the value MUST be a registered 704 relation type (see [RFC8288] and IANA Link Relations [2]). 706 Links with a rel of "enclosure" SHOULD be considered by the client 707 as attachments for download. 709 Links with a rel of "describedby" SHOULD be considered by the 710 client to be an alternate representation of the description. 712 Links with a rel of "icon" SHOULD be considered by the client to 713 be an image that it MAY use when presenting the calendar data to a 714 user. The "display" property MAY be set to indicate the purpose 715 of this image. 717 o display: String (optional). Describes the intended purpose of a 718 link to an image. If set, the "rel" property MUST be set to 719 "icon". The value MUST be either one of the following values, 720 registered in a future RFC, or a vendor-specific value: 722 * "badge": an image inline with the title of the object 724 * "graphic": a full image replacement for the object itself 726 * "fullsize": an image that is used to enhance the object 728 * "thumbnail": a smaller variant of "fullsize " to be used when 729 space for the image is constrained 731 o title: String (optional). A human-readable plain-text description 732 of the resource. 734 4.2.7. locale 736 Type: String (optional). 738 The [RFC5646] language tag that best describes the locale used for 739 the calendar object, if known. 741 4.2.8. keywords 743 Type: String[Boolean] (optional). 745 A set of keywords or tags that relate to the object. The set is 746 represented as a map, with the keys being the keywords. The value 747 for each key in the map MUST be "true". 749 4.2.9. categories 751 Type: String[Boolean] (optional). 753 A set of categories that relate to the calendar object. The set is 754 represented as a map, with the keys being the categories specified as 755 URIs. The value for each key in the map MUST be "true". 757 In contrast to keywords, categories typically are structured. For 758 example, a vendor owning the domain "example.com" might define the 759 categories "http://example.com/categories/sports/american-football"" 760 and "http://example.com/categories/music/r-b". 762 4.2.10. color 764 Type: String (optional). 766 Specifies a color clients MAY use when displaying this calendar 767 object. The value is a case-insensitive color name taken from the 768 CSS3 set of names, defined in Section 4.3 of W3C.REC- 769 css3-color-20110607 [3] or a CSS3 RGB color hex value. 771 4.3. Recurrence properties 773 4.3.1. recurrenceRule 775 Type: Recurrence (optional). 777 Defines a recurrence rule (repeating pattern) for recurring calendar 778 objects. 780 A Recurrence object is a JSON object mapping of a RECUR value type in 781 iCalendar, see [RFC5545] and[RFC7529]. A JSEvent recurs by applying 782 the recurrence rule to the start date-time. A JSTask recurs by 783 applying the recurrence rule to the start date-time, if defined, 784 otherwise it recurs by the due date-time, if defined. If the task 785 neither defines a start or due date-time, its "recurrenceRule" 786 property value MUST be "null". 788 A Recurrence object has the following properties: 790 o frequency: String (mandatory). This MUST be one of the following 791 values: 793 * "yearly" 795 * "monthly" 797 * "weekly" 799 * "daily" 801 * "hourly" 803 * "minutely" 805 * "secondly" 806 To convert from iCalendar, simply lower-case the FREQ part. 808 o interval: Number (optional, default: "1"). The INTERVAL part from 809 iCalendar. If included, it MUST be an integer "x >= 1". 811 o rscale: String (optional, default: ""gregorian""). The RSCALE 812 part from iCalendar RSCALE [RFC7529], converted to lower-case. 814 o skip: String (optional, default: ""omit""). The SKIP part from 815 iCalendar RSCALE [RFC7529], converted to lower-case. 817 o firstDayOfWeek: String (optional, default: ""mo""). The WKST part 818 from iCalendar, represented as a lower-case abbreviated two-letter 819 English day of the week. If included, it MUST be one of the 820 following values: ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 822 o byDay: NDay[] (optional). An *NDay* object has the following 823 properties: 825 * day: String. The day-of-the-week part of the BYDAY value in 826 iCalendar, lower-cased. MUST be one of the following values: 827 ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 829 * nthOfPeriod: Number (optional). The ordinal part of the BYDAY 830 value in iCalendar (e.g. ""+1"" or ""-3""). If present, rather 831 than representing every occurrence of the weekday defined in 832 the "day" property, it represents only a specific instance 833 within the recurrence period. The value can be positive or 834 negative, but MUST NOT be zero. A negative integer means nth- 835 last of period. 837 o byMonthDay: Number[] (optional). The BYMONTHDAY part from 838 iCalendar. The array MUST have at least one entry if included. 840 o byMonth: String[] (optional). The BYMONTH part from iCalendar. 841 Each entry is a string representation of a number, starting from 842 "1" for the first month in the calendar (e.g. ""1" " means 843 ""January"" with Gregorian calendar), with an optional ""L"" 844 suffix (see [RFC7529]) for leap months (this MUST be upper-case, 845 e.g. ""3L""). The array MUST have at least one entry if included. 847 o byYearDay: Number[] (optional). The BYYEARDAY part from 848 iCalendar. The array MUST have at least one entry if included. 850 o byWeekNo: Number[] (optional). The BYWEEKNO part from iCalendar. 851 The array MUST have at least one entry if included. 853 o byHour: Number[] (optional). The BYHOUR part from iCalendar. The 854 array MUST have at least one entry if included. 856 o byMinute: Number[] (optional). The BYMINUTE part from iCalendar. 857 The array MUST have at least one entry if included. 859 o bySecond: Number[] (optional). The BYSECOND part from iCalendar. 860 The array MUST have at least one entry if included. 862 o bySetPosition: Number[] (optional). The BYSETPOS part from 863 iCalendar. The array MUST have at least one entry if included. 865 o count: Number (optional). The COUNT part from iCalendar. This 866 MUST NOT be included if an "until" property is specified. 868 o until: LocalDate (optional). The UNTIL part from iCalendar. This 869 MUST NOT be included if a "count" property is specified. Note: if 870 not specified otherwise for a specific JSCalendar object, this 871 date is presumed to be in the time zone specified in "timeZone". 872 As in iCalendar, the until value bounds the recurrence rule 873 inclusively. 875 A recurrence rule specifies a set of set of date-times for recurring 876 calendar objects. A recurrence rule has the following semantics. 877 Note, wherever "year", "month" or "day of month" is used, this is 878 within the calendar system given by the "rscale" property, which 879 defaults to gregorian if omitted. 881 1. A set of candidates is generated. This is every second within a 882 period defined by the frequency property value: 884 * "yearly": every second from midnight on the 1st day of a year 885 (inclusive) to midnight the 1st day of the following year 886 (exclusive). 888 If skip is not "omit", the calendar system has leap months and 889 there is a byMonth property, generate candidates for the leap 890 months even if they don't occur in this year. 892 If skip is not "omit" and there is a byMonthDay property, 893 presume each month has the maximum number of days any month 894 may have in this calendar system when generating candidates, 895 even if it's more than this month actually has. 897 * "monthly": every second from midnight on the 1st day of a 898 month (inclusive) to midnight on the 1st of the following 899 month (exclusive). 901 If skip is not "omit" and there is a byMonthDay property, 902 presume the month has the maximum number of days any month may 903 have in this calendar system when generating candidates, even 904 if it's more than this month actually has. 906 * "weekly": every second from midnight (inclusive) on the first 907 day of the week (as defined by the firstDayOfWeek property, or 908 Monday if omitted), to midnight 7 days later (exclusive). 910 * "daily": every second from midnight at the start of the day 911 (inclusive) to midnight at the end of the day (exclusive). 913 * "hourly": every second from the beginning of the hour 914 (inclusive) to the beginning of the next hour (exclusive). 916 * "minutely": every second from the beginning of the minute 917 (inclusive) to the beginning of the next minute (exclusive). 919 * "secondly": the second itself, only. 921 2. Each date-time candidate is compared against all of the byX 922 properties of the rule except bySetPosition. If any property in 923 the rule does not match the date-time, it is eliminated. Each 924 byX property is an array; the date-time matches the property if 925 it matches any of the values in the array. The properties have 926 the following semantics: 928 * byMonth: the date-time is in the given month. 930 * byWeekNo: the date-time is in the nth week of the year. 931 Negative numbers mean the nth last week of the year. This 932 corresponds to weeks according to week numbering as defined in 933 ISO.8601.2004, with a week defined as a seven day period, 934 starting on the firstDayOfWeek property value or Monday if 935 omitted. Week number one of the calendar year is the first 936 week that contains at least four days in that calendar year. 938 If the date-time is not valid (this may happen when generating 939 candidates with a skip property in effect), it is always 940 eliminated by this property. 942 * byYearDay: the date-time is on the nth day of year. Negative 943 numbers mean the nth last day of the year. 945 If the date-time is not valid (this may happen when generating 946 candidates with a skip property in effect), it is always 947 eliminated by this property. 949 * byMonthDay: the date-time is on the given day of the month. 950 Negative numbers mean the nth last day of the month. 952 * byDay: the date-time is on the given day of the week. If the 953 day is prefixed by a number, it is the nth occurrence of that 954 day of the week within the month (if frequency is monthly) or 955 year (if frequency is yearly). Negative numbers means nth 956 last occurrence within that period. 958 * byHour: the date-time has the given hour value. 960 * byMinute: the date-time has the given minute value. 962 * bySecond: the date-time has the given second value. 964 If a skip property is defined and is not "omit", there may be 965 candidates that do not correspond to valid dates (e.g. 31st 966 Februrary in the gregorian calendar). In this case, the 967 properties MUST be considered in the order above and: 969 1. After applying the byMonth filter, if the candidate's month 970 is invalid for the given year increment it (if skip is 971 "forward") or decrement it (if skip is "backward") until a 972 valid month is found, incrementing/decrementing the year as 973 well if you pass through the beginning/end of the year. This 974 only applies to calendar systems with leap months. 976 2. After applying the byMonthDay filter, if the day of the month 977 is invalid for the given month and year, change the date to 978 the first day of the next month (if skip == "forward") or the 979 last day of the current month (if skip == "backward"). 981 3. If any valid date produced after applying the skip is already 982 a candidate, eliminate the duplicate. (For example after 983 adjusting, 30th Februrary and 31st February would both become 984 the same "real" date, so one is eliminated as a duplicate.) 986 3. If a bySetPosition property is included, this is now applied to 987 the ordered list of remaining dates (this property specifies the 988 indexes of date-times to keep; all others should be eliminated. 989 Negative numbers are indexes from the end of the list, with -1 990 being the last item). 992 4. Any date-times before the start date of the event are eliminated 993 (see below for why this might be needed). 995 5. If a skip property is included and is not "omit", eliminate any 996 date-times that have already been produced by previous iterations 997 of the algorithm. (This is not possible if skip == "omit".) 999 6. If further dates are required (we have not reached the until 1000 date, or count limit) skip the next (interval - 1) sets of 1001 candidates, then continue from step 1. 1003 When determining the set of occurrence dates for an event or task, 1004 the following extra rules must be applied: 1006 1. The start date-time is always the first occurrence in the 1007 expansion (and is counted if the recurrence is limited by a 1008 "count" property), even if it would normally not match the rule. 1010 2. The first set of candidates to consider is that which would 1011 contain the start date-time. This means the first set may 1012 include candidates before the start; such candidates are 1013 eliminated from the results in step (4) as outlined before. 1015 3. The following properties MUST be implicitly added to the rule 1016 under the given conditions: 1018 * If frequency > "secondly" and no bySecond property: Add a 1019 bySecond property with the sole value being the seconds value 1020 of the start date-time. 1022 * If frequency > "minutely" and no byMinute property: Add a 1023 byMinute property with the sole value being the minutes value 1024 of the start date-time. 1026 * If frequency > "hourly" and no byHour property: Add a byHour 1027 property with the sole value being the hours value of the 1028 start date-time. 1030 * If frequency is "weekly" and no byDay property: Add a byDay 1031 property with the sole value being the day-of-the-week of the 1032 start date-time. 1034 * If frequency is "monthly" and no byDay property and no 1035 byMonthDay property: Add a byMonthDay property with the sole 1036 value being the day-of-the-month of the start date-time. 1038 * If frequency is "yearly" and no byYearDay property: 1040 + if there are no byMonth or byWeekNo properties, and either 1041 there is a byMonthDay property or there is no byDay 1042 property: Add a byMonth property with the sole value being 1043 the month of the start date-time. 1045 + if there is no byMonthDay, byWeekNo or byDay properties: 1046 Add a byMonthDay property with the sole value being the 1047 day-of-the-month of the start date-time. 1049 + if there is a byWeekNo property and no byMonthDay or byDay 1050 properties: Add a byDay property with the sole value being 1051 the day-of-the-week of the start date-time. 1053 4.3.2. recurrenceOverrides 1055 Type: LocalDate[PatchObject] (optional). 1057 A map of the recurrence-ids (the date-time of the start of the 1058 occurrence) to an object of patches to apply to the generated 1059 occurrence object. 1061 If the recurrence-id does not match an expanded start date from a 1062 recurrence rule, it is to be treated as an additional occurrence 1063 (like an RDATE from iCalendar). The patch object may often be empty 1064 in this case. 1066 If the patch object defines the "excluded" property value to be 1067 "true", then the recurring calendar object does not occur at the 1068 recurrence-id date-time (like an EXDATE from iCalendar). Such a 1069 patch object MUST NOT patch any other property. 1071 By default, an occurrence inherits all properties from the main 1072 object except the start (or due) date-time, which is shifted to the 1073 new start time of the LocalDate key. However, individual properties 1074 of the occurrence can be modified by a patch, or multiple patches. 1075 It is valid to patch the start property value, and this patch takes 1076 precedence over the LocalDate key. Both the LocalDate key as well as 1077 the patched start date-time may occur before the original JSCalendar 1078 object's start or due date. 1080 A pointer in the PatchObject MUST NOT start with one of the following 1081 prefixes; any patch with such a key MUST be ignored: 1083 o @type 1085 o uid 1087 o relatedTo 1089 o prodId 1090 o method 1092 o recurrenceRule 1094 o recurrenceOverrides 1096 o replyTo 1098 4.3.3. excluded 1100 Type: Boolean (optional, default: "false"). 1102 Defines if this object is an overridden, excluded instance of a 1103 recurring JSCalendar object (also see Section 4.3.2). If this 1104 property value is "true", this calendar object instance MUST be 1105 removed from the occurrence expansion. The absence of this property 1106 or its default value "false" indicates that this instance MUST be 1107 added to the occurrence expansion. 1109 4.4. Sharing and scheduling properties 1111 4.4.1. priority 1113 Type: Number (optional, default: "0"). 1115 Specifies a priority for the calendar object. This may be used as 1116 part of scheduling systems to help resolve conflicts for a time 1117 period. 1119 The priority is specified as an integer in the range 0 to 9. A value 1120 of 0 specifies an undefined priority. A value of 1 is the highest 1121 priority. A value of 2 is the second highest priority. Subsequent 1122 numbers specify a decreasing ordinal priority. A value of 9 is the 1123 lowest priority. Other integer values are reserved for future use. 1125 4.4.2. freeBusyStatus 1127 Type: String (optional, default: "busy"). 1129 Specifies how this property should be treated when calculating free- 1130 busy state. The value MUST be one of: 1132 o ""free"": The object should be ignored when calculating whether 1133 the user is busy. 1135 o ""busy"": The object should be included when calculating whether 1136 the user is busy. 1138 4.4.3. privacy 1140 Type: String (optional, default: "public"). 1142 Calendar objects are normally collected together and may be shared 1143 with other users. The privacy property allows the object owner to 1144 indicate that it should not be shared, or should only have the time 1145 information shared but the details withheld. Enforcement of the 1146 restrictions indicated by this property are up to the 1147 implementations. 1149 This property MUST NOT affect the information sent to scheduled 1150 participants; it is only interpreted when the object is shared as 1151 part of a shared calendar. 1153 The value MUST be either one of the following values, registered in a 1154 future RFC, or a vendor-specific value. Vendor specific values MUST 1155 be prefixed with a domain name controlled by the vendor, e.g. 1156 "example.com/topsecret". Any value the client or server doesn't 1157 understand should be preserved but treated as equivalent to 1158 "private". 1160 o "public": The full details of the object are visible to those whom 1161 the object's calendar is shared with. 1163 o "private": The details of the object are hidden; only the basic 1164 time and metadata is shared. The following properties MAY be 1165 shared, any other properties MUST NOT be shared: 1167 * @type 1169 * uid 1171 * created 1173 * updated 1175 * sequence 1177 * freeBusyStatus 1179 * privacy 1181 * start 1183 * isAllDay 1185 * timeZone 1186 * timeZones 1188 * duration 1190 * estimatedDuration 1192 * due 1194 * recurrenceOverrides. Only patches whose keys are prefixed with 1195 one of the above properties are allowed to be shared. 1197 o "secret": The object is hidden completely (as though it did not 1198 exist) when the object is shared. 1200 4.4.4. replyTo 1202 Type: String[String] (optional). 1204 Represents methods by which participants may submit their RSVP 1205 response to the organizer of the calendar object. The keys in the 1206 property value are the available methods and MUST only contain ASCII 1207 alphanumeric characters (A-Za-z0-9). The value is a URI to use that 1208 method. Future methods may be defined in future specifications; a 1209 calendar client MUST ignore any method it does not understand, but 1210 MUST preserve the method key and URI. This property MUST be omitted 1211 if no method is defined (rather than an empty object). If this 1212 property is set, the "participants" property of this calendar object 1213 MUST contain at least one participant. 1215 The following methods are defined: 1217 o "imip": The organizer accepts an iMIP [RFC6047] response at this 1218 email address. The value MUST be a "mailto:" URI. 1220 o "web": Opening this URI in a web browser will provide the user 1221 with a page where they can submit a reply to the organizer. 1223 o "other": The organizer is identified by this URI but the method 1224 how to submit the RSVP is undefined. 1226 4.4.5. participants 1228 Type: String[Participant] (optional). 1230 A map of participant identifiers to participants, describing their 1231 participation in the calendar object. 1233 If this property is set, then the "replyTo" property of this calendar 1234 object MUST define at least one reply method. 1236 A Participant object has the following properties: 1238 o name: String (optional). The display name of the participant 1239 (e.g. "Joe Bloggs"). 1241 o email: String (optional). The email address for the participant. 1243 o sendTo: String[String]. Represents methods by which the 1244 participant may receive the invitation and updates to the calendar 1245 object. 1247 The keys in the property value are the available methods and MUST 1248 only contain ASCII alphanumeric characters (A-Za-z0-9). The value 1249 is a URI to use that method. Future methods may be defined in 1250 future specifications; a calendar client MUST ignore any method it 1251 does not understand, but MUST preserve the method key and URI. 1252 This property MUST be omitted if no method is defined (rather than 1253 an empty object). 1255 The following methods are defined: 1257 * "imip": The participant accepts an iMIP [RFC6047] request at 1258 this email address. The value MUST be a "mailto:" URI. It MAY 1259 be different from the value of the participant's "email" 1260 property. 1262 * "other": The participant is identified by this URI but the 1263 method how to submit the invitation or update is undefined. 1265 o kind: String (optional). What kind of entity this participant is, 1266 if known. 1268 This MUST be either one of the following values, registered in a 1269 future RFC, or a vendor-specific value. Any value the client or 1270 server doesn't understand should be treated the same as if this 1271 property is omitted. 1273 * "individual": a single person 1275 * "group": a collection of people invited as a whole 1277 * "resource": a non-human resource, e.g. a projector 1279 * "location": a physical location involved in the calendar object 1280 that needs to be scheduled, e.g. a conference room. 1282 o roles: String[Boolean]. A set of roles that this participant 1283 fulfills. 1285 At least one role MUST be specified for the participant. The keys 1286 in the set MUST be either one of the following values, registered 1287 in a future RFC, or a vendor-specific value: 1289 * "owner": The participant is an owner of the object. 1291 * "attendee": The participant is an attendee of the calendar 1292 object. 1294 * "chair": The participant is in charge of the calendar object 1295 when it occurs. 1297 The value for each key in the set MUST be "true". Roles that are 1298 unknown to the implementation MUST be preserved and MAY be 1299 ignored. 1301 o locationId: String (optional). The location at which this 1302 participant is expected to be attending. 1304 If the value does not correspond to any location id in the 1305 "locations" property of the instance, this MUST be treated the 1306 same as if the participant's locationId were omitted. 1308 o participationStatus: String (optional, default: "needs-action"). 1309 The participation status, if any, of this participant. 1311 The value MUST be either one of the following values, registered 1312 in a future RFC, or a vendor-specific value: 1314 * "needs-action": No status yet set by the participant. 1316 * "accepted": The invited participant will participate. 1318 * "declined": The invited participant will not participate. 1320 * "tentative": The invited participant may participate. 1322 o attendance: String (optional, default: "required"). The required 1323 attendance of this participant. 1325 The value MUST be either one of the following values, registered 1326 in a future RFC, or a vendor-specific value. Any value the client 1327 or server doesn't understand should be treated the same as 1328 "required". 1330 * "none": Indicates a participant who is copied for information 1331 purposes only. 1333 * "optional": Indicates a participant whose attendance is 1334 optional. 1336 * "required": Indicates a participant whose attendance is 1337 required. 1339 o expectReply: Boolean (optional, default: "false"). If true, the 1340 organizer is expecting the participant to notify them of their 1341 status. 1343 o scheduleSequence: Number (optional, default: "0"). The sequence 1344 number of the last response from the participant. If defined, 1345 this MUST be a non-negative integer. 1347 This can be used to determine whether the participant has sent a 1348 new RSVP following significant changes to the calendar object, and 1349 to determine if future responses are responding to a current or 1350 older view of the data. 1352 o scheduleUpdated: UTCDate (optional). The "updated" property of 1353 the last iMIP response from the participant. 1355 This can be compared to the "updated" property timestamp in future 1356 iMIP responses to determine if the response is older or newer than 1357 the current data. 1359 o invitedBy: String (optional). The participant id of the 1360 participant who invited this one, if known. 1362 o delegatedTo: String[Boolean] (optional). A set of participant ids 1363 that this participant has delegated their participation to. Each 1364 key in the set MUST be the identifier of a participant. The value 1365 for each key in the set MUST be "true". This MUST be omitted if 1366 none (rather than an empty set). 1368 o delegatedFrom: String[Boolean] (optional). A set of participant 1369 ids that this participant is acting as a delegate for. Each key 1370 in the set MUST be the identifier of a participant. The value for 1371 each key in the set MUST be "true". This MUST be omitted if none 1372 (rather than an empty set). 1374 o memberOf: String[Boolean] (optional). A set of group participants 1375 that were invited to this calendar object, which caused this 1376 participant to be invited due to their membership of the group(s). 1377 Each key in the set MUST be the identifier of a participant. The 1378 value for each key in the set MUST be "true". This MUST be 1379 omitted if none (rather than an empty set). 1381 o linkIds: String[Boolean] (optional). A set of links to more 1382 information about this participant, for example in vCard format. 1383 The keys in the set MUST be the identifier of a Link object in the 1384 calendar object's "links" property. The value for each key in the 1385 set MUST be "true". This MUST be omitted if none (rather than an 1386 empty set). 1388 4.5. Alerts properties 1390 4.5.1. useDefaultAlerts 1392 Type: Boolean (optional, default: "false"). 1394 If "true", use the user's default alerts and ignore the value of the 1395 "alerts" property. Fetching user defaults is dependent on the API 1396 from which this JSCalendar object is being fetched, and is not 1397 defined in this specification. If an implementation cannot determine 1398 the user's default alerts, or none are set, it MUST process the 1399 alerts property as if useDefaultAlerts is set to "false". 1401 4.5.2. alerts 1403 Type: String[Alert] (optional). 1405 A map of alert identifiers to Alert objects, representing alerts/ 1406 reminders to display or send the user for this calendar object. 1408 An Alert Object has the following properties: 1410 o trigger: OffsetTrigger|UnknownTrigger. Defines when to trigger 1411 the alert. 1413 An *OffsetTrigger* object has the following properties: 1415 * type: String (mandatory). The value of this property MUST be 1416 "offset". 1418 * offset: SignedDuration (mandatory). Defines to trigger the 1419 alert relative to the time property defined in the "relativeTo" 1420 property. If the calendar object does not define a time zone, 1421 the user's default time zone SHOULD be used when determining 1422 the offset, if known. Otherwise, the time zone to use is 1423 implementation specific. 1425 * relativeTo: String (optional, default: "start"). Specifies the 1426 time property which the alert offset is relative to. The value 1427 MUST be one of: 1429 + "start": triggers the alert relative to the start of the 1430 calendar object 1432 + "end": triggers the alert relative to the end/due time of 1433 the calendar object 1435 An *UnknownTrigger* object is an object that contains a *type* 1436 property whose value is not "offset", plus zero or more other 1437 properties. This is for compatibility with client extensions and 1438 future RFCs. Implementations SHOULD NOT trigger for trigger types 1439 they do not understand, but MUST preserve them. 1441 o acknowledged: UTCDate (optional). 1443 When the user has permanently dismissed the alert the client MUST 1444 set this to the current time in UTC. Other clients which sync 1445 this property can then automatically dismiss or suppress duplicate 1446 alerts (alerts with the same alert id that triggered on or before 1447 this date-time). 1449 For a recurring calendar object, the "acknowledged" property of 1450 the parent object MUST be updated, unless the alert is already 1451 overridden in the "recurrenceOverrides" property. 1453 o snoozed: UTCDate (optional). 1455 If the user temporarily dismisses the alert, this is the UTC date- 1456 time after which it should trigger again. Setting this property 1457 on an instance of a recurring calendar object MUST update the 1458 alarm on the top-level object, unless the respective instance 1459 already is defined in "recurrenceOverrides". It MUST NOT generate 1460 an override for the sole use of snoozing an alarm. 1462 o action: String (optional, default: "display"). Describes how to 1463 alert the user. 1465 The value MUST be at most one of the following values, registered 1466 in a future RFC, or a vendor-specific value: 1468 * "display": The alert should be displayed as appropriate for the 1469 current device and user context. 1471 * "email": The alert should trigger an email sent out to the 1472 user, notifying about the alert. This action is typically only 1473 appropriate for server implementations. 1475 4.6. Multilingual properties 1477 4.6.1. localizations 1479 Type: String[PatchObject] (optional). 1481 A map of [RFC5646] language tags to patch objects, which localize the 1482 calendar object into the locale of the respective language tag. 1484 See the description of PatchObject (Section 3.2.4) for the structure 1485 of the PatchObject. The patches are applied to the top-level object. 1486 In addition to all the restrictions on patches specified there, the 1487 pointer also MUST NOT start with one of the following prefixes; any 1488 patch with a such a key MUST be ignored: 1490 o @type 1492 o due 1494 o duration 1496 o freeBusyStatus 1498 o localization 1500 o method 1502 o participants 1504 o prodId 1506 o progress 1508 o relatedTo 1510 o sequence 1512 o start 1514 o status 1516 o timeZone 1518 o uid 1519 o useDefaultAlerts 1521 Note that this specification does not define how to maintain validity 1522 of localized content. For example, a client application changing a 1523 JSCalendar object's title property might also need to update any 1524 localizations of this property. Client implementations SHOULD 1525 provide the means to manage localizations, but how to achieve this is 1526 specific to the application's workflow and requirements. 1528 4.7. Time zone properties 1530 4.7.1. timeZones 1532 Type: String[TimeZone] (optional). 1534 Maps identifiers of custom time zones to their time zone definition. 1535 The following restrictions apply for each key in the map: 1537 o It MUST start with the "/" character (ASCII decimal 47; also see 1538 sections 3.2.19 of [RFC5545] and 3.6. of [RFC7808] for discussion 1539 of the forward slash character in time zone identifiers). 1541 o It MUST be a valid "paramtext" value as specified in section 3.1. 1542 of [RFC5545]. 1544 o At least one other property in the same JSCalendar object MUST 1545 reference a time zone using this identifier (i.e. orphaned time 1546 zones are not allowed). 1548 An identifier need only be unique to this JSCalendar object. 1550 A TimeZone object maps a VTIMEZONE component from iCalendar 1551 ([RFC5545]). A valid time zone MUST define at least one transition 1552 rule in the "standard" or "daylight" property. Its properties are: 1554 o tzId: String (mandatory). The TZID property from iCalendar. 1556 o lastModified: UTCDate (optional). The LAST-MODIFIED property from 1557 iCalendar. 1559 o url: String (optional). The TZURL property from iCalendar. 1561 o validUntil: UTCDate (optional). The TZUNTIL property from 1562 iCalendar specified in [RFC7808]. 1564 o aliases: String[Boolean] (optional). Maps the TZID-ALIAS-OF 1565 properties from iCalendar specified in [RFC7808] to a JSON set of 1566 aliases. The set is represented as an object, with the keys being 1567 the aliases. The value for each key in the set MUST be "true". 1569 o standard: TimeZoneRule[] (optional). The STANDARD sub-components 1570 from iCalendar. The order MUST be preserved during conversion. 1572 o daylight: TimeZoneRule[] (optional). The DAYLIGHT sub-components 1573 from iCalendar. The order MUST be preserved during conversion. 1575 A TimeZoneRule object maps a STANDARD or DAYLIGHT sub-component from 1576 iCalendar, with the restriction that at most one recurrence rule is 1577 allowed per rule. It has the following properties: 1579 o start: LocalDate (mandatory). The DTSTART property from 1580 iCalendar. 1582 o offsetTo: String (mandatory). The TZOFFSETTO property from 1583 iCalendar. 1585 o offsetFrom: String (mandatory). The TZOFFSETFROM property from 1586 iCalendar. 1588 o recurrenceRule: RecurrenceRule (optional). The RRULE property 1589 mapped as specified in Section 4.3.1. During recurrence rule 1590 evaluation, the "until" property value MUST be interpreted as a 1591 local time in the UTC time zone. 1593 o recurrenceDates: LocalDate[Boolean] (optional). Maps the RDATE 1594 properties from iCalendar to a JSON set. The set is represented 1595 as an object, with the keys being the recurrence dates. The value 1596 for each key in the set MUST be "true". 1598 o names: String[Boolean] (optional). Maps the TZNAME properties 1599 from iCalendar to a JSON set. The set is represented as an 1600 object, with the keys being the names. The value for each key in 1601 the set MUST be "true". 1603 o comments: String[] (optional). Maps the COMMENT properties from 1604 iCalendar. The order MUST be preserved during conversion. 1606 5. Type-specific JSCalendar properties 1608 5.1. JSEvent properties 1610 In addition to the common JSCalendar object properties (Section 4) a 1611 JSEvent has the following properties: 1613 5.1.1. start 1615 Type: LocalDate (mandatory). 1617 The date/time the event would start in the event's time zone. 1619 5.1.2. timeZone 1621 Type: String|null (optional, default: "null"). 1623 Identifies the time zone the event is scheduled in, or "null" for 1624 floating time. If omitted, this MUST be presumed to be "null" (i.e. 1625 floating time). Also see Section 3.2.6. 1627 5.1.3. duration 1629 Type: Duration (optional, default: "PT0S"). 1631 The zero or positive duration of the event in the event's start time 1632 zone. The same rules as for the iCalendar DURATION value type 1633 ([RFC5545]) apply: The duration of a week or a day in hours/minutes/ 1634 seconds may vary if it overlaps a period of discontinuity in the 1635 event's time zone, for example a change from standard time to 1636 daylight-savings time. Leap seconds MUST NOT be considered when 1637 computing an exact duration. When computing an exact duration, the 1638 greatest order time components MUST be added first, that is, the 1639 number of days MUST be added first, followed by the number of hours, 1640 number of minutes, and number of seconds. Fractional seconds MUST be 1641 added last. 1643 A JSEvent MAY involve start and end locations that are in different 1644 time zones (e.g. a trans-continental flight). This can be expressed 1645 using the "relativeTo" and "timeZone" properties of the JSEvent's 1646 "location" objects. 1648 5.1.4. isAllDay 1650 Type: Boolean (optional, default: "false"). 1652 Indicates whether this event is meant to represent an all-day event, 1653 and SHOULD be presented accordingly in a calendaring application. 1654 The value of this property is independent of the actual time-span 1655 covered by this event. 1657 5.1.5. status 1659 Type: String (optional, default: "confirmed"). 1661 The scheduling status (Section 4.4) of a JSEvent. If set, it MUST be 1662 one of: 1664 o "confirmed": Indicates the event is definite. 1666 o "cancelled": Indicates the event is cancelled. 1668 o "tentative": Indicates the event is tentative. 1670 5.2. JSTask properties 1672 In addition to the common JSCalendar object properties (Section 4) a 1673 JSTask has the following properties: 1675 5.2.1. due 1677 Type: LocalDate (optional). 1679 The date/time the task is due in the task's time zone. 1681 5.2.2. start 1683 Type: LocalDate (optional). 1685 The date/time the task should start in the task's time zone. 1687 5.2.3. timeZone 1689 Type: String|null (optional, default: "null"). 1691 Identifies the time zone the task is scheduled in, or "null" for 1692 floating time. If omitted, this MUST be presumed to be "null" (i.e. 1693 floating time). Also see Section 3.2.6. 1695 5.2.4. estimatedDuration 1697 Type: Duration (optional). 1699 Specifies the estimated positive duration of time the task takes to 1700 complete. 1702 5.2.5. statusUpdatedAt 1704 Type: UTCDate (optional). 1706 Specifies the date/time the task status properties was last updated. 1708 If the task is recurring and has future instances, a client may want 1709 to keep track of the last status update timestamp of a specific task 1710 recurrence, but leave other instances unchanged. One way to achieve 1711 this is by overriding the statusUpdatedAt property in the task 1712 "recurrenceOverrides" property. However, this could produce a long 1713 list of timestamps for regularly recurring tasks. An alternative 1714 approach is to split the JSTask into a current, single instance of 1715 JSTask with this instance status update time and a future recurring 1716 instance. Also see Section 4.1.3 on splitting. 1718 5.2.6. progress 1720 In addition to the common properties of a Participant object 1721 (Section 4.4.5), a Participant within a JSTask supports the following 1722 property: 1724 o progress: ParticipantProgress (optional). The progress of the 1725 participant for this task, if known. This property MUST NOT be 1726 set if the "participationStatus" of this participant is any other 1727 value but "accepted". 1729 A ParticipantProgress object has the following properties: 1731 o status: String (mandatory). Describes the completion status of 1732 the participant's progress. 1734 The value MUST be at most one of the following values, registered 1735 in a future RFC, or a vendor-specific value: 1737 * "completed": The participant completed their task. 1739 * "in-process": The participant has started this task. 1741 * "failed": The participant failed to complete their task. 1743 o timestamp: UTCDate (mandatory). Describes the last time when the 1744 participant progress got updated. 1746 5.2.7. status 1748 Type: String (optional). 1750 Defines the overall status of this task. If omitted, the default 1751 status (Section 4.4) of a JSTask is defined as follows (in order of 1752 evaluation): 1754 o "completed": if the "status" property value of all participant 1755 progresses is "completed". 1757 o "failed": if at least one "status" property value of the 1758 participant progresses is "failed". 1760 o "in-process": if at least one "status" property value of the 1761 participant progresses is "in-process". 1763 o "needs-action": If none of the other criteria match. 1765 If set, it MUST be one of: 1767 o "needs-action": Indicates the task needs action. 1769 o "completed": Indicates the task is completed. 1771 o "in-process": Indicates the task is in process. 1773 o "cancelled": Indicates the task is cancelled. 1775 o "pending": Indicates the task has been created and accepted for 1776 processing, but not yet started. 1778 o "failed": Indicates the task failed. 1780 5.3. JSGroup properties 1782 JSGroup supports the following JSCalendar properties (Section 4): 1784 o @type 1786 o uid 1788 o created 1790 o updated 1792 o categories 1793 o keywords 1795 o name 1797 o description 1799 o color 1801 o links 1803 as well as the following JSGroup-specific properties: 1805 5.3.1. entries 1807 Type: String[JSTask|JSEvent] (mandatory). 1809 A collection of group members. This is represented as a map of the 1810 "uid" property value to the JSCalendar object member having that uid. 1811 Implementations MUST ignore entries of unknown type. 1813 5.3.2. source 1815 Type: String (optional). 1817 The source from which updated versions of this group may be retrieved 1818 from. The value MUST be a URI. 1820 6. JSCalendar object examples 1822 The following examples illustrate several aspects of the JSCalendar 1823 data model and format. The examples may omit mandatory or additional 1824 properties, which is indicated by a placeholder property with key 1825 "...". While most of the examples use calendar event objects, they 1826 are also illustrative for tasks. 1828 6.1. Simple event 1830 This example illustrates a simple one-time event. It specifies a 1831 one-time event that begins on January 15, 2018 at 1pm New York local 1832 time and ends after 1 hour. 1834 { 1835 "@type": "jsevent", 1836 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 1837 "updated": "2018-01-15T18:00:00Z", 1838 "title": "Some event", 1839 "start": "2018-01-15T13:00:00", 1840 "timeZone": "America/New_York", 1841 "duration": "PT1H" 1842 } 1844 6.2. Simple task 1846 This example illustrates a simple task for a plain to-do item. 1848 { 1849 "@type": "jstask", 1850 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 1851 "updated": "2018-01-15T18:00:00Z", 1852 "title": "Do something" 1853 } 1855 6.3. Simple group 1857 This example illustrates a simple calendar object group that contains 1858 an event and a task. 1860 { 1861 "@type": "jsgroup", 1862 "uid": "2a358cee-6489-4f14-a57f-c104db4dc343", 1863 "updated": "2018-01-15T18:00:00Z", 1864 "name": "A simple group", 1865 "entries": [ 1866 { 1867 "@type": "jsevent", 1868 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 1869 "updated": "2018-01-15T18:00:00Z", 1870 "title": "Some event", 1871 "start": "2018-01-15T13:00:00", 1872 "timeZone": "America/New_York", 1873 "duration": "PT1H" 1874 }, 1875 { 1876 "@type": "jstask", 1877 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 1878 "updated": "2018-01-15T18:00:00Z", 1879 "title": "Do something" 1880 } 1881 ] 1882 } 1884 6.4. All-day event 1886 This example illustrates an event for an international holiday. It 1887 specifies an all-day event on April 1 that occurs every year since 1888 the year 1900. 1890 { 1891 "...": "", 1892 "title": "April Fool's Day", 1893 "isAllDay": true, 1894 "start": "1900-04-01T00:00:00", 1895 "duration": "P1D", 1896 "recurrenceRule": { 1897 "frequency": "yearly" 1898 } 1899 } 1901 6.5. Task with a due date 1903 This example illustrates a task with a due date. It is a reminder to 1904 buy groceries before 6pm Vienna local time on January 19, 2018. The 1905 calendar user expects to need 1 hour for shopping. 1907 { 1908 "...": "", 1909 "title": "Buy groceries", 1910 "due": "2018-01-19T18:00:00", 1911 "timeZone": "Europe/Vienna", 1912 "estimatedDuration": "PT1H" 1913 } 1915 6.6. Event with end time-zone 1917 This example illustrates the use of end time-zones by use of an 1918 international flight. The flight starts on April 1, 2018 at 9am in 1919 Berlin local time. The duration of the flight is scheduled at 10 1920 hours 30 minutes. The time at the flights destination is in the same 1921 time-zone as Tokyo. Calendar clients could use the end time-zone to 1922 display the arrival time in Tokyo local time and highlight the time- 1923 zone difference of the flight. The location names can serve as input 1924 for navigation systems. 1926 { 1927 "...": "", 1928 "title": "Flight XY51 to Tokyo", 1929 "start": "2018-04-01T09:00:00", 1930 "timeZone": "Europe/Berlin", 1931 "duration": "PT10H30M", 1932 "locations": { 1933 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 1934 "rel": "start", 1935 "name": "Frankfurt Airport (FRA)" 1936 }, 1937 "c2c7ac67-dc13-411e-a7d4-0780fb61fb08": { 1938 "rel": "end", 1939 "name": "Narita International Airport (NRT)", 1940 "timeZone": "Asia/Tokyo" 1941 } 1942 } 1943 } 1945 6.7. Floating-time event (with recurrence) 1947 This example illustrates the use of floating-time. Since January 1, 1948 2018, a calendar user blocks 30 minutes every day to practice Yoga at 1949 7am local time, in whatever time-zone the user is located on that 1950 date. 1952 { 1953 "...": "", 1954 "title": "Yoga", 1955 "start": "2018-01-01T07:00:00", 1956 "duration": "PT30M", 1957 "recurrenceRule": { 1958 "frequency": "daily" 1959 } 1960 } 1962 6.8. Event with multiple locations and localization 1964 This example illustrates an event that happens at both a physical and 1965 a virtual location. Fans can see a live convert on premises or 1966 online. The event title and descriptions are localized. 1968 { 1969 "...": "", 1970 "title": "Live from Music Bowl: The Band", 1971 "description": "Go see the biggest music event ever!", 1972 "locale": "en", 1973 "start": "2018-07-04T17:00:00", 1974 "timeZone": "America/New_York", 1975 "duration": "PT3H", 1976 "locations": { 1977 "c0503d30-8c50-4372-87b5-7657e8e0fedd": { 1978 "name": "The Music Bowl", 1979 "description": "Music Bowl, Central Park, New York", 1980 "coordinates": "geo:40.7829,73.9654" 1981 } 1982 }, 1983 "virtualLocations": { 1984 "6f3696c6-1e07-47d0-9ce1-f50014b0041a": { 1985 "name": "Free live Stream from Music Bowl", 1986 "uri": "https://stream.example.com/the_band_2018" 1987 } 1988 }, 1989 "localizations": { 1990 "de": { 1991 "title": "Live von der Music Bowl: The Band!", 1992 "description": "Schau dir das groesste Musikereignis an!", 1993 "virtualLocations/6f3696c6-1e07-47d0-9ce1-f50014b0041a/name": 1994 "Gratis Live-Stream aus der Music Bowl" 1995 } 1996 } 1997 } 1999 6.9. Recurring event with overrides 2001 This example illustrates the use of recurrence overrides. A math 2002 course at a University is held for the first time on January 8, 2018 2003 at 9am London time and occurs every week until June 25, 2018. Each 2004 lecture lasts for one hour and 30 minutes and is located at the 2005 Mathematics department. This event has exceptional occurrences: at 2006 the last occurrence of the course is an exam, which lasts for 2 hours 2007 and starts at 10am. Also, the location of the exam differs from the 2008 usual location. On April 2 no course is held. On January 5 at 2pm 2009 is an optional introduction course, that occurs before the first 2010 regular lecture. 2012 { 2013 "...": "", 2014 "title": "Calculus I", 2015 "start": "2018-01-08T09:00:00", 2016 "timeZone": "Europe/London", 2017 "duration": "PT1H30M", 2018 "locations": { 2019 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2020 "title": "Math lab room 1", 2021 "description": "Math Lab I, Department of Mathematics" 2022 } 2023 }, 2024 "recurrenceRule": { 2025 "frequency": "weekly", 2026 "until": "2018-06-25T09:00:00" 2027 }, 2028 "recurrenceOverrides": { 2029 "2018-01-05T14:00:00": { 2030 "title": "Introduction to Calculus I (optional)" 2031 }, 2032 "2018-04-02T09:00:00": { 2033 "excluded": "true" 2034 }, 2035 "2018-06-25T09:00:00": { 2036 "title": "Calculus I Exam", 2037 "start": "2018-06-25T10:00:00", 2038 "duration": "PT2H", 2039 "locations": { 2040 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2041 "title": "Big Auditorium", 2042 "description": "Big Auditorium, Other Road" 2043 } 2044 } 2045 } 2046 } 2047 } 2049 6.10. Recurring event with participants 2051 This example illustrates scheduled events. A team meeting occurs 2052 every week since January 8, 2018 at 9am Johannesburg time. The event 2053 owner also chairs the event. Participants meet in a virtual meeting 2054 room. An attendee has accepted the invitation, but on March 8, 2018 2055 he is unavailable and declined participation for this occurrence. 2057 { 2058 "...": "", 2059 "title": "FooBar team meeting", 2060 "start": "2018-01-08T09:00:00", 2061 "timeZone": "Africa/Johannesburg", 2062 "duration": "PT1H", 2063 "virtualLocations": { 2064 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2065 "name": "ChatMe meeting room", 2066 "uri": "https://chatme.example.com?id=1234567" 2067 } 2068 }, 2069 "recurrenceRule": { 2070 "frequency": "weekly" 2071 }, 2072 "replyTo": { 2073 "imip": "mailto:6489-4f14-a57f-c1@schedule.example.com" 2074 }, 2075 "participants": { 2076 "dG9tQGZvb2Jhci5leGFtcGxlLmNvbQ": { 2077 "name": "Tom Tool", 2078 "email": "tom@foobar.example.com", 2079 "sendTo": { 2080 "imip": "mailto:6489-4f14-a57f-c1@calendar.example.com" 2081 }, 2082 "participationStatus": "accepted", 2083 "roles": { 2084 "attendee": true 2085 } 2086 }, 2087 "em9lQGZvb2Jhci5leGFtcGxlLmNvbQ": { 2088 "name": "Zoe Zelda", 2089 "email": "zoe@foobar.example.com", 2090 "sendTo": { 2091 "imip": "mailto:zoe@foobar.example.com" 2092 }, 2093 "participationStatus": "accepted", 2094 "roles": { 2095 "owner": true, 2096 "attendee": true, 2097 "chair": true 2098 } 2099 }, 2100 "...": "" 2101 }, 2102 "recurrenceOverrides": { 2103 "2018-03-08T09:00:00": { 2104 "participants/dG9tQGZvb2Jhci5leGFtcGxlLmNvbQ/participationStatus": 2105 "declined" 2106 } 2107 } 2109 } 2111 7. Security Considerations 2113 The use of JSON as a format does have its own inherent security risks 2114 as discussed in Section 12 of [RFC8259]. Even though JSON is 2115 considered a safe subset of JavaScript, it should be kept in mind 2116 that a flaw in the parser processing JSON could still impose a 2117 threat, which doesn't arise with conventional iCalendar data. 2119 With this in mind, a parser for JSON data aware of the security 2120 implications should be used for the format described in this 2121 document. For example, the use of JavaScript's "eval()" function is 2122 considered an unacceptable security risk, as described in Section 12 2123 of[RFC8259]. A native parser with full awareness of the JSON format 2124 should be preferred. 2126 8. IANA Considerations 2128 This document defines a MIME media type for use with JSCalendar data 2129 formatted in JSON. 2131 Type name: application 2133 Subtype name: jscalendar+json 2135 Required parameters: type 2137 The "type" parameter conveys the type of the JSCalendar data in 2138 the body part, with the value being one of "jsevent", "jstask", or 2139 "jsgroup". The parameter MUST NOT occur more than once. It MUST 2140 match the value of the "@type" property of the JSON-formatted 2141 JSCalendar object in the body. 2143 Optional parameters: none 2145 Encoding considerations: Same as encoding considerations of 2146 application/json as specified in RFC8529, Section 11 [RFC8259]. 2148 Security considerations: See Section 7 of this document. 2150 Interoperability considerations: This media type provides an 2151 alternative to iCalendar, jCal and proprietary JSON-based 2152 calendaring data formats. 2154 Published specification: This specification. 2156 Applications that use this media type: Applications that currently 2157 make use of the text/calendar and application/calendar+json media 2158 types can use this as an alternative. Similarily, applications 2159 that use the application/json media type to transfer calendaring 2160 data can use this to further specify the content. 2162 Fragment identifier considerations: N/A 2164 Additional information: 2166 Magic number(s): N/A 2168 File extensions(s): N/A 2170 Macintosh file type code(s): N/A 2172 Person & email address to contact for further 2173 information: 2174 calext@ietf.org 2176 Intended usage: COMMON 2178 Restrictions on usage: N/A 2180 Author: See the "Author's Address" section of this document. 2182 Change controller: IETF 2184 9. Acknowledgments 2186 The authors would like to thank the members of CalConnect for their 2187 valuable contributions. This specification originated from the work 2188 of the API technical committee of CalConnect, the Calendaring and 2189 Scheduling Consortium. 2191 10. References 2193 10.1. Normative References 2195 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2196 Requirement Levels", BCP 14, RFC 2119, 2197 DOI 10.17487/RFC2119, March 1997, 2198 . 2200 [RFC2392] Levinson, E., "Content-ID and Message-ID Uniform Resource 2201 Locators", RFC 2392, DOI 10.17487/RFC2392, August 1998, 2202 . 2204 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 2205 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 2206 . 2208 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 2209 Resource Identifier (URI): Generic Syntax", STD 66, 2210 RFC 3986, DOI 10.17487/RFC3986, January 2005, 2211 . 2213 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 2214 Unique IDentifier (UUID) URN Namespace", RFC 4122, 2215 DOI 10.17487/RFC4122, July 2005, 2216 . 2218 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data 2219 Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006, 2220 . 2222 [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault, 2223 "Calendaring Extensions to WebDAV (CalDAV)", RFC 4791, 2224 DOI 10.17487/RFC4791, March 2007, 2225 . 2227 [RFC5545] Desruisseaux, B., Ed., "Internet Calendaring and 2228 Scheduling Core Object Specification (iCalendar)", 2229 RFC 5545, DOI 10.17487/RFC5545, September 2009, 2230 . 2232 [RFC5546] Daboo, C., Ed., "iCalendar Transport-Independent 2233 Interoperability Protocol (iTIP)", RFC 5546, 2234 DOI 10.17487/RFC5546, December 2009, 2235 . 2237 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 2238 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 2239 September 2009, . 2241 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 2242 Identifier for Geographic Locations ('geo' URI)", 2243 RFC 5870, DOI 10.17487/RFC5870, June 2010, 2244 . 2246 [RFC6047] Melnikov, A., Ed., "iCalendar Message-Based 2247 Interoperability Protocol (iMIP)", RFC 6047, 2248 DOI 10.17487/RFC6047, December 2010, 2249 . 2251 [RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type 2252 Specifications and Registration Procedures", BCP 13, 2253 RFC 6838, DOI 10.17487/RFC6838, January 2013, 2254 . 2256 [RFC6901] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., 2257 "JavaScript Object Notation (JSON) Pointer", RFC 6901, 2258 DOI 10.17487/RFC6901, April 2013, 2259 . 2261 [RFC7265] Kewisch, P., Daboo, C., and M. Douglass, "jCal: The JSON 2262 Format for iCalendar", RFC 7265, DOI 10.17487/RFC7265, May 2263 2014, . 2265 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 2266 DOI 10.17487/RFC7493, March 2015, 2267 . 2269 [RFC7529] Daboo, C. and G. Yakushev, "Non-Gregorian Recurrence Rules 2270 in the Internet Calendaring and Scheduling Core Object 2271 Specification (iCalendar)", RFC 7529, 2272 DOI 10.17487/RFC7529, May 2015, 2273 . 2275 [RFC7808] Douglass, M. and C. Daboo, "Time Zone Data Distribution 2276 Service", RFC 7808, DOI 10.17487/RFC7808, March 2016, 2277 . 2279 [RFC7986] Daboo, C., "New Properties for iCalendar", RFC 7986, 2280 DOI 10.17487/RFC7986, October 2016, 2281 . 2283 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 2284 Interchange Format", STD 90, RFC 8259, 2285 DOI 10.17487/RFC8259, December 2017, 2286 . 2288 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 2289 DOI 10.17487/RFC8288, October 2017, 2290 . 2292 10.2. Informative References 2294 [MIME] "IANA Media Types", . 2297 10.3. URIs 2299 [1] https://www.iana.org/time-zones 2301 [2] https://www.iana.org/assignments/link-relations/link- 2302 relations.xhtml 2304 [3] https://www.w3.org/TR/2011/REC-css3-color-20110607/#svg-color 2306 Authors' Addresses 2308 Neil Jenkins 2309 FastMail 2310 PO Box 234 2311 Collins St West 2312 Melbourne VIC 8007 2313 Australia 2315 Email: neilj@fastmailteam.com 2316 URI: https://www.fastmail.com 2318 Robert Stepanek 2319 FastMail 2320 PO Box 234 2321 Collins St West 2322 Melbourne VIC 8007 2323 Australia 2325 Email: rsto@fastmailteam.com 2326 URI: https://www.fastmail.com