idnits 2.17.1 draft-ietf-calext-jscalendar-16.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 24, 2019) is 1767 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 2308 == Missing Reference: 'Relation' is mentioned on line 497, but not defined == Missing Reference: 'Boolean' is mentioned on line 1612, but not defined == Missing Reference: 'Location' is mentioned on line 617, but not defined == Missing Reference: 'VirtualLocation' is mentioned on line 662, but not defined == Missing Reference: 'Link' is mentioned on line 686, but not defined -- Looks like a reference, but probably isn't: '2' on line 2310 -- Looks like a reference, but probably isn't: '3' on line 2313 == Missing Reference: 'PatchObject' is mentioned on line 1493, but not defined == Missing Reference: 'String' is mentioned on line 1257, but not defined == Missing Reference: 'Participant' is mentioned on line 1242, but not defined == Missing Reference: 'Alert' is mentioned on line 1417, but not defined == Missing Reference: 'TimeZone' is mentioned on line 1546, 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 26, 2019 June 24, 2019 7 JSCalendar: A JSON representation of calendar data 8 draft-ietf-calext-jscalendar-16 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 26, 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. showWithoutTime . . . . . . . . . . . . . . . . . . . 13 88 4.2.5. locations . . . . . . . . . . . . . . . . . . . . . . 14 89 4.2.6. virtualLocations . . . . . . . . . . . . . . . . . . 15 90 4.2.7. links . . . . . . . . . . . . . . . . . . . . . . . . 15 91 4.2.8. locale . . . . . . . . . . . . . . . . . . . . . . . 16 92 4.2.9. keywords . . . . . . . . . . . . . . . . . . . . . . 17 93 4.2.10. categories . . . . . . . . . . . . . . . . . . . . . 17 94 4.2.11. color . . . . . . . . . . . . . . . . . . . . . . . . 17 95 4.3. Recurrence properties . . . . . . . . . . . . . . . . . . 17 96 4.3.1. recurrenceRule . . . . . . . . . . . . . . . . . . . 17 97 4.3.2. recurrenceOverrides . . . . . . . . . . . . . . . . . 23 98 4.3.3. excluded . . . . . . . . . . . . . . . . . . . . . . 24 99 4.4. Sharing and scheduling properties . . . . . . . . . . . . 24 100 4.4.1. priority . . . . . . . . . . . . . . . . . . . . . . 24 101 4.4.2. freeBusyStatus . . . . . . . . . . . . . . . . . . . 25 102 4.4.3. privacy . . . . . . . . . . . . . . . . . . . . . . . 25 103 4.4.4. replyTo . . . . . . . . . . . . . . . . . . . . . . . 26 104 4.4.5. participants . . . . . . . . . . . . . . . . . . . . 27 105 4.5. Alerts properties . . . . . . . . . . . . . . . . . . . . 30 106 4.5.1. useDefaultAlerts . . . . . . . . . . . . . . . . . . 30 107 4.5.2. alerts . . . . . . . . . . . . . . . . . . . . . . . 30 108 4.6. Multilingual properties . . . . . . . . . . . . . . . . . 32 109 4.6.1. localizations . . . . . . . . . . . . . . . . . . . . 32 110 4.7. Time zone properties . . . . . . . . . . . . . . . . . . 33 111 4.7.1. timeZones . . . . . . . . . . . . . . . . . . . . . . 33 112 5. Type-specific JSCalendar properties . . . . . . . . . . . . . 35 113 5.1. JSEvent properties . . . . . . . . . . . . . . . . . . . 35 114 5.1.1. start . . . . . . . . . . . . . . . . . . . . . . . . 35 115 5.1.2. timeZone . . . . . . . . . . . . . . . . . . . . . . 35 116 5.1.3. duration . . . . . . . . . . . . . . . . . . . . . . 35 117 5.1.4. 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 . . . . . . . . . . . . . . . . . 51 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] and extensions, but 167 the 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 is mostly a 177 pragmatic choice: its widespread use makes JSCalendar easier to 178 adopt, and the ready availability of production-ready JSON 179 implementations eliminates a whole category of parser-related 180 interoperability issues. 182 1.1. Relation to the iCalendar format 184 The iCalendar data format [RFC5545], a widely deployed interchange 185 format for calendaring and scheduling data, has served calendaring 186 vendors for a long while, but contains some ambiguities and pitfalls 187 that can not be overcome without backward-incompatible changes. 189 For example, iCalendar defines various formats for local times, UTC 190 time and dates, which confuses new users. Other sources for errors 191 are the requirement for custom time zone definitions within a single 192 calendar component, as well as the iCalendar format itself; the 193 latter causing interoperability issues due to misuse of CR LF 194 terminated strings, line continuations and subtle differences between 195 iCalendar parsers. Lastly, up until recently the iCalendar format 196 did not have a way to express a concise difference between two 197 calendar components, which results in verbose exchanges during 198 scheduling. 200 1.2. Relation to the jCal format 202 The JSON format for iCalendar data, jCal [RFC7265], is a direct 203 mapping between iCalendar and JSON. It does not attempt to extend or 204 update iCalendar semantics, and consequently does not address the 205 issues outlined in Section 1.1. 207 Since the standardization of jCal, the majority of implementations 208 and service providers either kept using iCalendar, or came up with 209 their own proprietary JSON representation, which often are 210 incompatible with each other. JSCalendar is intended to meet this 211 demand for JSON formatted calendar data, and to provide a standard 212 representation as an alternative to new proprietary formats. 214 1.3. Notational Conventions 216 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 217 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 218 document are to be interpreted as described in [RFC2119]. 220 The underlying format used for this specification is JSON. 221 Consequently, the terms "object" and "array" as well as the four 222 primitive types (strings, numbers, booleans, and null) are to be 223 interpreted as described in Section 1 of [RFC8259]. 225 Some examples in this document contain "partial" JSON documents used 226 for illustrative purposes. In these examples, three periods "..." 227 are used to indicate a portion of the document that has been removed 228 for compactness. 230 2. JSCalendar objects 232 This section describes the calendar object types specified by 233 JSCalendar. 235 2.1. JSEvent 237 MIME type: "application/jscalendar+json;type=jsevent" 238 A JSEvent represents a scheduled amount of time on a calendar, 239 typically a meeting, appointment, reminder or anniversary. Multiple 240 participants may partake in the event at multiple locations. 242 The @type (Section 4.1.1) property value MUST be "jsevent". 244 2.2. JSTask 246 MIME type: "application/jscalendar+json;type=jstask" 248 A JSTask represents an action-item, assignment, to-do or work item. 250 The @type (Section 4.1.1) property value MUST be "jstask". 252 A JSTask may start and be due at certain points in time, may take 253 some estimated time to complete and may recur; none of which is 254 required. This notably differs from JSEvent (Section 2.1) which is 255 required to start at a certain point in time and typically takes some 256 non-zero duration to complete. 258 2.3. JSGroup 260 MIME type: "application/jscalendar+json;type=jsgroup" 262 A JSGroup is a collection of JSEvent (Section 2.1) and JSTask 263 (Section 2.2) objects. Typically, objects are grouped by topic (e.g. 264 by keywords) or calendar membership. 266 The @type (Section 4.1.1) property value MUST be "jsgroup". 268 3. Structure of JSCalendar objects 270 A JSCalendar object is a JSON object, which MUST be valid I-JSON (a 271 stricter subset of JSON), as specified in [RFC8259]. Property names 272 and values are case-sensitive. 274 The object has a collection of properties, as specified in the 275 following sections. Properties are specified as being either 276 mandatory or optional. Optional properties may have a default value, 277 if explicitly specified in the property definition. 279 3.1. Type signatures 281 Types signatures are given for all JSON objects in this document. 282 The following conventions are used: 284 o "Boolean|String": The value is either a JSON "Boolean" value, or a 285 JSON "String" value. 287 o "Foo": Any name that is not a native JSON type means an object for 288 which the properties (and their types) are defined elsewhere 289 within this document. 291 o "Foo[]": An array of objects of type "Foo". 293 o "String[Foo]": A JSON "Object" being used as a map (associative 294 array), where all the values are of type "Foo". 296 3.2. Data Types 298 In addition to the standard JSON data types, the following data types 299 are used in this specification: 301 3.2.1. UTCDate 303 This is a string in [RFC3339] "date-time" format, with the further 304 restrictions that any letters MUST be in upper-case, the time 305 component MUST be included and the time MUST be in UTC. Fractional 306 second values MUST NOT be included unless non-zero and MUST NOT have 307 trailing zeros, to ensure there is only a single representation for 308 each date-time. 310 For example "2010-10-10T10:10:10.003Z" is OK, but 311 "2010-10-10T10:10:10.000Z" is invalid and MUST be encoded as 312 "2010-10-10T10:10:10Z". 314 In common notation, it should be of the form "YYYY-MM-DDTHH:MM:SSZ". 316 3.2.2. LocalDate 318 This is a date-time string _with no time zone/offset information_. 319 It is otherwise in the same format as UTCDate, including fractional 320 seconds. For example "2006-01-02T15:04:05" and 321 "2006-01-02T15:04:05.003" are both valid. The time zone to associate 322 the LocalDate with comes from an associated property, or if no time 323 zone is associated it defines _floating time_. Floating date-times 324 are not tied to any specific time zone. Instead, they occur in every 325 time zone at the same wall-clock time (as opposed to the same instant 326 point in time). 328 3.2.3. Duration 330 A Duration object is represented by a subset of ISO8601 duration 331 format, as specified by the following ABNF: 333 dur-secfrac = "." 1*DIGIT 334 dur-second = 1*DIGIT [dur-secfrac] "S" 335 dur-minute = 1*DIGIT "M" [dur-second] 336 dur-hour = 1*DIGIT "H" [dur-minute] 337 dur-time = "T" (dur-hour / dur-minute / dur-second) 338 dur-day = 1*DIGIT "D" 339 dur-week = 1*DIGIT "W" 341 duration = "P" (dur-day [dur-time] / dur-time / dur-week) 343 In addition, the duration MUST NOT include fractional second values 344 unless the fraction is non-zero. 346 A SignedDuration object is represented as a duration, optionally 347 preceded by a sign character. It typically is used to express the 348 offset of a point in time relative to an associated time. It is 349 specified by the following ABNF: 351 signed-duration = (["+"] / "-") duration 353 A negative sign indicates a point in time at or before the associated 354 time, a positive or no sign a time at or after the associated time. 356 3.2.4. PatchObject 358 A PatchObject is of type "String[*|null]", and represents an 359 unordered set of patches on a JSON object. The keys are a path in a 360 subset of [RFC6901] JSON pointer format, with an implicit leading "/" 361 (i.e. prefix each key with "/" before applying the JSON pointer 362 evaluation algorithm). 364 A patch within a PatchObject is only valid, if all of the following 365 conditions apply: 367 1. The pointer MUST NOT reference inside an array (i.e. it MUST NOT 368 insert/delete from an array; the array MUST be replaced in its 369 entirety instead). 371 2. When evaluating a path, all parts prior to the last (i.e. the 372 value after the final slash) MUST exist. 374 3. There MUST NOT be two patches in the PatchObject where the 375 pointer of one is the prefix of the pointer of the other, e.g. 376 "alerts/foo/offset" and "alerts". 378 The value associated with each pointer is either: 380 o "null": Remove the property from the patched object. If not 381 present in the parent, this a no-op. 383 o Anything else: The value to replace the inherited property on the 384 patch object with (if present) or add to the property (if not 385 present). 387 Implementations MUST reject a PatchObject if any of its patches are 388 invalid. 390 3.2.5. Identifiers 392 If not stated otherwise in the respective property definition, 393 properties and object keys that define identifiers MUST be string 394 values, MUST be at least 1 character and maximum 256 characters in 395 size, and MUST only contain characters from the "URL and Filename 396 safe" Base 64 Alphabet, as defined in section 5 of [RFC4648]. This 397 is the ASCII alphanumeric characters (A-Za-z0-9), hyphen (-), and 398 underscore (_). Note that [RFC7493] requires string values be 399 encoded in UTF-8, so the maximum size of an identifier according to 400 this definition is 256 octets. 402 . Identifiers in object maps need not be universally unique, e.g. two 403 calendar objects MAY use the same identifiers in their respective 404 "links" properties. 406 Nevertheless, a UUID typically is a good choice. 408 3.2.6. Time Zones 410 By default, time zones in JSCalendar are identified by their name in 411 the IANA Time Zone Database [1], and the zone rules of the respective 412 zone record apply. 414 Implementations MAY embed the definition of custom time zones in the 415 "timeZones" property (see Section 4.7.1). 417 3.2.7. Normalization and equivalence 419 JSCalendar aims to provide unambiguous definitions for value types 420 and properties, but does not define a general normalization or 421 equivalence method for JSCalendar objects and types. This is because 422 the notion of equivalence might range from byte-level equivalence to 423 semantic equivalence, depending on the respective use case (for 424 example, the CalDAV protocol [RFC4791] requires octet equivalence of 425 the encoded calendar object to determine ETag equivalence). 427 Normalization of JSCalendar objects is hindered because of the 428 following reasons: 430 o Custom JSCalendar properties may contain arbitrary JSON values, 431 including arrays. However, equivalence of arrays might or might 432 not depend on the order of elements, depending on the respective 433 property definition. 435 o Several JSCalendar property values are defined as URIs and MIME 436 types, but normalization of these types is inherently protocol and 437 scheme-specific, depending on the use-case of the equivalence 438 definition (see section 6 of [RFC3986]). 440 Considering this, the definition of equivalence and normalization is 441 left to client and server implementations and to be negotiated by a 442 calendar exchange protocol or defined by another RFC. 444 3.3. Custom property extensions and values 446 Vendors MAY add additional properties to the calendar object to 447 support their custom features. The names of these properties MUST be 448 prefixed with a domain name controlled by the vendor to avoid 449 conflict, e.g. "example.com/customprop". 451 Some JSCalendar properties allow vendor-specific value extensions. 452 If so, vendor specific values MUST be prefixed with a domain name 453 controlled by the vendor, e.g. "example.com/customrel", unless 454 otherwise noted. 456 4. Common JSCalendar properties 458 This section describes the properties that are common to the various 459 JSCalendar object types. Specific JSCalendar object types may only 460 support a subset of these properties. The object type definitions in 461 Section 5 describe the set of supported properties per type. 463 4.1. Metadata properties 465 4.1.1. @type 467 Type: String (mandatory). 469 Specifies the type which this object represents. This MUST be one of 470 the following values, registered in a future RFC, or a vendor- 471 specific value: 473 o "jsevent": a JSCalendar event (Section 2.1). 475 o "jstask": a JSCalendar task (Section 2.2). 477 o "jsgroup": a JSCalendar group (Section 2.3). 479 4.1.2. uid 481 Type: String (mandatory). 483 A globally unique identifier, used to associate the object as the 484 same across different systems, calendars and views. The value of 485 this property MUST be unique across all JSCalendar objects, even if 486 they are of different type. [RFC4122] describes a range of 487 established algorithms to generate universally unique identifiers 488 (UUID), and the random or pseudo-random version is recommended. 490 For compatibility with [RFC5545] UIDs, implementations MUST be able 491 to receive and persist values of at least 255 octets for this 492 property, but they MUST NOT truncate values in the middle of a UTF-8 493 multi-octet sequence. 495 4.1.3. relatedTo 497 Type: String[Relation] (optional). 499 Relates the object to other JSCalendar objects. This is represented 500 as a map of the UIDs of the related objects to information about the 501 relation. 503 A Relation object has the following properties: 505 o relation: String[Boolean] (optional). Describes how the linked 506 object is related to this object as a set of relation types. If 507 not null, the set MUST NOT be empty. 509 Keys in the set MUST be one of the following values, defined in a 510 future specification or a vendor-specific value: 512 * "first": The linked object is the first in the series this 513 object is part of. 515 * "next": The linked object is the next in the series this object 516 is part of. 518 * "child": The linked object is a subpart of this object. 520 * "parent": This object is part of the overall linked object. 522 The value for each key in the set MUST be "true". 524 If an object is split to make a "this and future" change to a 525 recurrence, the original object MUST be truncated to end at the 526 previous occurrence before this split, and a new object created to 527 represent all the objects after the split. A "next" relation MUST be 528 set on the original object's relatedTo property for the UID of the 529 new object. A "first" relation for the UID of the first object in 530 the series MUST be set on the new object. Clients can then follow 531 these UIDs to get the complete set of objects if the user wishes to 532 modify them all at once. 534 4.1.4. prodId 536 Type: String (optional). 538 The identifier for the product that created the JSCalendar object. 540 The vendor of the implementation SHOULD ensure that this is a 541 globally unique identifier, using some technique such as an FPI 542 value, as defined in [ISO.9070.1991]. It MUST only use characters of 543 an iCalendar TEXT data value (see section 3.3.11 in [RFC5545]). 545 This property SHOULD NOT be used to alter the interpretation of an 546 JSCalendar object beyond the semantics specified in this document. 547 For example, it is not to be used to further the understanding of 548 non-standard properties. 550 4.1.5. created 552 Type: UTCDate (optional). 554 The date and time this object was initially created. 556 4.1.6. updated 558 Type: UTCDate (mandatory). 560 The date and time the data in this object was last modified. 562 4.1.7. sequence 564 Type: Number (optional, default: "0"). 566 Initially zero, this MUST be a non-negative integer that is 567 monotonically incremented each time a change is made to the object. 569 4.1.8. method 571 Type: String (optional). 573 The iTIP ([RFC5546]) method, in lower-case. Used for scheduling. 575 4.2. What and where properties 577 4.2.1. title 579 Type: String (optional, default: empty String). 581 A short summary of the object. 583 4.2.2. description 585 Type: String (optional, default: empty String). 587 A longer-form text description of the object. The content is 588 formatted according to the "descriptionContentType" property. 590 4.2.3. descriptionContentType 592 Type: String (optional, default: "text/plain"). 594 Describes the media type ([RFC6838]) of the contents of the 595 "description" property. Media types MUST be sub-types of type 596 "text", and SHOULD be "text/plain" or "text/html" ([MIME]). They MAY 597 define parameters and the "charset" parameter value MUST be "utf-8", 598 if specified. Descriptions of type "text/html" MAY contain "cid" 599 URLs ([RFC2392]) to reference links in the calendar object by use of 600 the "cid" property of the Link object. 602 4.2.4. showWithoutTime 604 Type: Boolean (optional, default: "false"). 606 Indicates the time is not important to display to the user when 607 rendering this calendar object, for example an event that 608 conceptually occurs all day or across multiple days, such as "New 609 Year's Day" or "Italy Vacation". While the time component is 610 important for free-busy calculations and checking for scheduling 611 clashes, calendars may choose to omit displaying it and/or display 612 the object separately to other objects to enhance the user's view of 613 their schedule. 615 4.2.5. locations 617 Type: String[Location] (optional). 619 A map of location identifiers to Location objects, representing 620 locations associated with the object. 622 A Location object has the following properties. It must define at 623 least one other property than the "relativeTo" property. 625 o name: String (optional, default: empty String). The human- 626 readable name of the location. 628 o description: String (optional). Human-readable, plain-text 629 instructions for accessing this location. This may be an address, 630 set of directions, door access code, etc. 632 o relativeTo: String (optional). The relation type of this location 633 to the JSCalendar object. 635 This MUST be either one of the following values, registered in a 636 future RFC, or a vendor-specific value. Any value the client or 637 server doesn't understand should be treated the same as if this 638 property is omitted. 640 * "start": The JSCalendar object starts at this location. 642 * "end": The JSCalendar object ends at this location. 644 o timeZone: String (optional). A time zone for this location. Also 645 see Section 3.2.6. 647 o coordinates: String (optional). An [RFC5870] "geo:" URI for the 648 location. 650 o linkIds: String[Boolean] (optional). A set of link ids for links 651 to alternate representations of this location. Each key in the 652 set MUST be the identifier of a Link object defined in the "links" 653 property of this calendar object. The value for each key in the 654 set MUST be "true". This MUST be omitted if none (rather than an 655 empty set). 657 For example, an alternative representation could be in vCard 658 format. 660 4.2.6. virtualLocations 662 Type: String[VirtualLocation] (optional). 664 A map of identifiers to VirtualLocation objects, representing virtual 665 locations, such as video conferences or chat rooms, associated with 666 the object. 668 A VirtualLocation object has the following properties. 670 o name: String (optional, default: empty String). The human- 671 readable name of the virtual location. 673 o description: String (optional). Human-readable plain-text 674 instructions for accessing this location. This may be an address, 675 set of directions, door access code, etc. 677 o uri: String (mandatory). A URI that represents how to connect to 678 this virtual location. 680 This may be a telephone number (represented as 681 "tel:+1-555-555-555") for a teleconference, a web address for 682 online chat, or any custom URI. 684 4.2.7. links 686 Type: String[Link] (optional). 688 A map of link identifiers to Link objects, representing external 689 resources associated with the object. 691 A Link object has the following properties: 693 o href: String (mandatory). A URI from which the resource may be 694 fetched. 696 This MAY be a "data:" URL, but it is recommended that the file be 697 hosted on a server to avoid embedding arbitrarily large data in 698 JSCalendar object instances. 700 o cid: String (optional). This MUST be a valid "content-id" value 701 according to the definition of section 2 in [RFC2392]. The 702 identifier MUST be unique within this JSCalendar object Link 703 objects but has no meaning beyond that. Specifically, it MAY be 704 different from the link identifier in the enclosing "links" 705 property. 707 o type: String (optional). The content-type [RFC6838] of the 708 resource, if known. 710 o size: Number (optional). The size, in bytes, of the resource when 711 fully decoded (i.e. the number of bytes in the file the user would 712 download), if known. 714 o rel: String (optional). Identifies the relation of the linked 715 resource to the object. If set, the value MUST be a registered 716 relation type (see [RFC8288] and IANA Link Relations [2]). 718 Links with a rel of "enclosure" SHOULD be considered by the client 719 as attachments for download. 721 Links with a rel of "describedby" SHOULD be considered by the 722 client to be an alternate representation of the description. 724 Links with a rel of "icon" SHOULD be considered by the client to 725 be an image that it MAY use when presenting the calendar data to a 726 user. The "display" property MAY be set to indicate the purpose 727 of this image. 729 o display: String (optional). Describes the intended purpose of a 730 link to an image. If set, the "rel" property MUST be set to 731 "icon". The value MUST be either one of the following values, 732 registered in a future RFC, or a vendor-specific value: 734 * "badge": an image inline with the title of the object 736 * "graphic": a full image replacement for the object itself 738 * "fullsize": an image that is used to enhance the object 740 * "thumbnail": a smaller variant of "fullsize" to be used when 741 space for the image is constrained 743 o title: String (optional). A human-readable plain-text description 744 of the resource. 746 4.2.8. locale 748 Type: String (optional). 750 The [RFC5646] language tag that best describes the locale used for 751 the calendar object, if known. 753 4.2.9. keywords 755 Type: String[Boolean] (optional). 757 A set of keywords or tags that relate to the object. The set is 758 represented as a map, with the keys being the keywords. The value 759 for each key in the map MUST be "true". 761 4.2.10. categories 763 Type: String[Boolean] (optional). 765 A set of categories that relate to the calendar object. The set is 766 represented as a map, with the keys being the categories specified as 767 URIs. The value for each key in the map MUST be "true". 769 In contrast to keywords, categories typically are structured. For 770 example, a vendor owning the domain "example.com" might define the 771 categories "http://example.com/categories/sports/american-football"" 772 and "http://example.com/categories/music/r-b". 774 4.2.11. color 776 Type: String (optional). 778 Specifies a color clients MAY use when displaying this calendar 779 object. The value is a case-insensitive color name taken from the 780 CSS3 set of names, defined in Section 4.3 of W3C.REC- 781 css3-color-20110607 [3] or a CSS3 RGB color hex value. 783 4.3. Recurrence properties 785 4.3.1. recurrenceRule 787 Type: Recurrence (optional). 789 Defines a recurrence rule (repeating pattern) for recurring calendar 790 objects. 792 A Recurrence object is a JSON object mapping of a RECUR value type in 793 iCalendar, see [RFC5545] and[RFC7529]. A JSEvent recurs by applying 794 the recurrence rule to the start date-time. A JSTask recurs by 795 applying the recurrence rule to the start date-time, if defined, 796 otherwise it recurs by the due date-time, if defined. If the task 797 neither defines a start or due date-time, its "recurrenceRule" 798 property value MUST be "null". 800 A Recurrence object has the following properties: 802 o frequency: String (mandatory). This MUST be one of the following 803 values: 805 * "yearly" 807 * "monthly" 809 * "weekly" 811 * "daily" 813 * "hourly" 815 * "minutely" 817 * "secondly" 819 To convert from iCalendar, simply lower-case the FREQ part. 821 o interval: Number (optional, default: "1"). The INTERVAL part from 822 iCalendar. If included, it MUST be an integer "x >= 1". 824 o rscale: String (optional, default: ""gregorian""). The RSCALE 825 part from iCalendar RSCALE [RFC7529], converted to lower-case. 827 o skip: String (optional, default: ""omit""). The SKIP part from 828 iCalendar RSCALE [RFC7529], converted to lower-case. 830 o firstDayOfWeek: String (optional, default: ""mo""). The WKST part 831 from iCalendar, represented as a lower-case abbreviated two-letter 832 English day of the week. If included, it MUST be one of the 833 following values: ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 835 o byDay: NDay[] (optional). An *NDay* object has the following 836 properties: 838 * day: String. The day-of-the-week part of the BYDAY value in 839 iCalendar, lower-cased. MUST be one of the following values: 840 ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 842 * nthOfPeriod: Number (optional). The ordinal part of the BYDAY 843 value in iCalendar (e.g. ""+1"" or ""-3""). If present, rather 844 than representing every occurrence of the weekday defined in 845 the "day" property, it represents only a specific instance 846 within the recurrence period. The value can be positive or 847 negative, but MUST NOT be zero. A negative integer means nth- 848 last of period. 850 o byMonthDay: Number[] (optional). The BYMONTHDAY part from 851 iCalendar. The array MUST have at least one entry if included. 853 o byMonth: String[] (optional). The BYMONTH part from iCalendar. 854 Each entry is a string representation of a number, starting from 855 "1" for the first month in the calendar (e.g. ""1" " means 856 ""January"" with Gregorian calendar), with an optional ""L"" 857 suffix (see [RFC7529]) for leap months (this MUST be upper-case, 858 e.g. ""3L""). The array MUST have at least one entry if included. 860 o byYearDay: Number[] (optional). The BYYEARDAY part from 861 iCalendar. The array MUST have at least one entry if included. 863 o byWeekNo: Number[] (optional). The BYWEEKNO part from iCalendar. 864 The array MUST have at least one entry if included. 866 o byHour: Number[] (optional). The BYHOUR part from iCalendar. The 867 array MUST have at least one entry if included. 869 o byMinute: Number[] (optional). The BYMINUTE part from iCalendar. 870 The array MUST have at least one entry if included. 872 o bySecond: Number[] (optional). The BYSECOND part from iCalendar. 873 The array MUST have at least one entry if included. 875 o bySetPosition: Number[] (optional). The BYSETPOS part from 876 iCalendar. The array MUST have at least one entry if included. 878 o count: Number (optional). The COUNT part from iCalendar. This 879 MUST NOT be included if an "until" property is specified. 881 o until: LocalDate (optional). The UNTIL part from iCalendar. This 882 MUST NOT be included if a "count" property is specified. Note: if 883 not specified otherwise for a specific JSCalendar object, this 884 date is presumed to be in the time zone specified in "timeZone". 885 As in iCalendar, the until value bounds the recurrence rule 886 inclusively. 888 A recurrence rule specifies a set of set of date-times for recurring 889 calendar objects. A recurrence rule has the following semantics. 890 Note, wherever "year", "month" or "day of month" is used, this is 891 within the calendar system given by the "rscale" property, which 892 defaults to gregorian if omitted. 894 1. A set of candidates is generated. This is every second within a 895 period defined by the frequency property value: 897 * "yearly": every second from midnight on the 1st day of a year 898 (inclusive) to midnight the 1st day of the following year 899 (exclusive). 901 If skip is not "omit", the calendar system has leap months and 902 there is a byMonth property, generate candidates for the leap 903 months even if they don't occur in this year. 905 If skip is not "omit" and there is a byMonthDay property, 906 presume each month has the maximum number of days any month 907 may have in this calendar system when generating candidates, 908 even if it's more than this month actually has. 910 * "monthly": every second from midnight on the 1st day of a 911 month (inclusive) to midnight on the 1st of the following 912 month (exclusive). 914 If skip is not "omit" and there is a byMonthDay property, 915 presume the month has the maximum number of days any month may 916 have in this calendar system when generating candidates, even 917 if it's more than this month actually has. 919 * "weekly": every second from midnight (inclusive) on the first 920 day of the week (as defined by the firstDayOfWeek property, or 921 Monday if omitted), to midnight 7 days later (exclusive). 923 * "daily": every second from midnight at the start of the day 924 (inclusive) to midnight at the end of the day (exclusive). 926 * "hourly": every second from the beginning of the hour 927 (inclusive) to the beginning of the next hour (exclusive). 929 * "minutely": every second from the beginning of the minute 930 (inclusive) to the beginning of the next minute (exclusive). 932 * "secondly": the second itself, only. 934 2. Each date-time candidate is compared against all of the byX 935 properties of the rule except bySetPosition. If any property in 936 the rule does not match the date-time, it is eliminated. Each 937 byX property is an array; the date-time matches the property if 938 it matches any of the values in the array. The properties have 939 the following semantics: 941 * byMonth: the date-time is in the given month. 943 * byWeekNo: the date-time is in the nth week of the year. 944 Negative numbers mean the nth last week of the year. This 945 corresponds to weeks according to week numbering as defined in 946 ISO.8601.2004, with a week defined as a seven day period, 947 starting on the firstDayOfWeek property value or Monday if 948 omitted. Week number one of the calendar year is the first 949 week that contains at least four days in that calendar year. 951 If the date-time is not valid (this may happen when generating 952 candidates with a skip property in effect), it is always 953 eliminated by this property. 955 * byYearDay: the date-time is on the nth day of year. Negative 956 numbers mean the nth last day of the year. 958 If the date-time is not valid (this may happen when generating 959 candidates with a skip property in effect), it is always 960 eliminated by this property. 962 * byMonthDay: the date-time is on the given day of the month. 963 Negative numbers mean the nth last day of the month. 965 * byDay: the date-time is on the given day of the week. If the 966 day is prefixed by a number, it is the nth occurrence of that 967 day of the week within the month (if frequency is monthly) or 968 year (if frequency is yearly). Negative numbers means nth 969 last occurrence within that period. 971 * byHour: the date-time has the given hour value. 973 * byMinute: the date-time has the given minute value. 975 * bySecond: the date-time has the given second value. 977 If a skip property is defined and is not "omit", there may be 978 candidates that do not correspond to valid dates (e.g. 31st 979 February in the gregorian calendar). In this case, the 980 properties MUST be considered in the order above and: 982 1. After applying the byMonth filter, if the candidate's month 983 is invalid for the given year increment it (if skip is 984 "forward") or decrement it (if skip is "backward") until a 985 valid month is found, incrementing/decrementing the year as 986 well if you pass through the beginning/end of the year. This 987 only applies to calendar systems with leap months. 989 2. After applying the byMonthDay filter, if the day of the month 990 is invalid for the given month and year, change the date to 991 the first day of the next month (if skip == "forward") or the 992 last day of the current month (if skip == "backward"). 994 3. If any valid date produced after applying the skip is already 995 a candidate, eliminate the duplicate. (For example after 996 adjusting, 30th February and 31st February would both become 997 the same "real" date, so one is eliminated as a duplicate.) 999 3. If a bySetPosition property is included, this is now applied to 1000 the ordered list of remaining dates (this property specifies the 1001 indexes of date-times to keep; all others should be eliminated. 1002 Negative numbers are indexes from the end of the list, with -1 1003 being the last item). 1005 4. Any date-times before the start date of the event are eliminated 1006 (see below for why this might be needed). 1008 5. If a skip property is included and is not "omit", eliminate any 1009 date-times that have already been produced by previous iterations 1010 of the algorithm. (This is not possible if skip == "omit".) 1012 6. If further dates are required (we have not reached the until 1013 date, or count limit) skip the next (interval - 1) sets of 1014 candidates, then continue from step 1. 1016 When determining the set of occurrence dates for an event or task, 1017 the following extra rules must be applied: 1019 1. The start date-time is always the first occurrence in the 1020 expansion (and is counted if the recurrence is limited by a 1021 "count" property), even if it would normally not match the rule. 1023 2. The first set of candidates to consider is that which would 1024 contain the start date-time. This means the first set may 1025 include candidates before the start; such candidates are 1026 eliminated from the results in step (4) as outlined before. 1028 3. The following properties MUST be implicitly added to the rule 1029 under the given conditions: 1031 * If frequency > "secondly" and no bySecond property: Add a 1032 bySecond property with the sole value being the seconds value 1033 of the start date-time. 1035 * If frequency > "minutely" and no byMinute property: Add a 1036 byMinute property with the sole value being the minutes value 1037 of the start date-time. 1039 * If frequency > "hourly" and no byHour property: Add a byHour 1040 property with the sole value being the hours value of the 1041 start date-time. 1043 * If frequency is "weekly" and no byDay property: Add a byDay 1044 property with the sole value being the day-of-the-week of the 1045 start date-time. 1047 * If frequency is "monthly" and no byDay property and no 1048 byMonthDay property: Add a byMonthDay property with the sole 1049 value being the day-of-the-month of the start date-time. 1051 * If frequency is "yearly" and no byYearDay property: 1053 + if there are no byMonth or byWeekNo properties, and either 1054 there is a byMonthDay property or there is no byDay 1055 property: Add a byMonth property with the sole value being 1056 the month of the start date-time. 1058 + if there is no byMonthDay, byWeekNo or byDay properties: 1059 Add a byMonthDay property with the sole value being the 1060 day-of-the-month of the start date-time. 1062 + if there is a byWeekNo property and no byMonthDay or byDay 1063 properties: Add a byDay property with the sole value being 1064 the day-of-the-week of the start date-time. 1066 4.3.2. recurrenceOverrides 1068 Type: LocalDate[PatchObject] (optional). 1070 A map of the recurrence-ids (the date-time of the start of the 1071 occurrence) to an object of patches to apply to the generated 1072 occurrence object. 1074 If the recurrence-id does not match an expanded start date from a 1075 recurrence rule, it is to be treated as an additional occurrence 1076 (like an RDATE from iCalendar). The patch object may often be empty 1077 in this case. 1079 If the patch object defines the "excluded" property value to be 1080 "true", then the recurring calendar object does not occur at the 1081 recurrence-id date-time (like an EXDATE from iCalendar). Such a 1082 patch object MUST NOT patch any other property. 1084 By default, an occurrence inherits all properties from the main 1085 object except the start (or due) date-time, which is shifted to the 1086 new start time of the LocalDate key. However, individual properties 1087 of the occurrence can be modified by a patch, or multiple patches. 1088 It is valid to patch the start property value, and this patch takes 1089 precedence over the LocalDate key. Both the LocalDate key as well as 1090 the patched start date-time may occur before the original JSCalendar 1091 object's start or due date. 1093 A pointer in the PatchObject MUST NOT start with one of the following 1094 prefixes; any patch with such a key MUST be ignored: 1096 o @type 1098 o uid 1100 o relatedTo 1102 o prodId 1104 o method 1106 o recurrenceRule 1108 o recurrenceOverrides 1110 o replyTo 1112 4.3.3. excluded 1114 Type: Boolean (optional, default: "false"). 1116 Defines if this object is an overridden, excluded instance of a 1117 recurring JSCalendar object (also see Section 4.3.2). If this 1118 property value is "true", this calendar object instance MUST be 1119 removed from the occurrence expansion. The absence of this property 1120 or its default value "false" indicates that this instance MUST be 1121 added to the occurrence expansion. 1123 4.4. Sharing and scheduling properties 1125 4.4.1. priority 1127 Type: Number (optional, default: "0"). 1129 Specifies a priority for the calendar object. This may be used as 1130 part of scheduling systems to help resolve conflicts for a time 1131 period. 1133 The priority is specified as an integer in the range 0 to 9. A value 1134 of 0 specifies an undefined priority. A value of 1 is the highest 1135 priority. A value of 2 is the second highest priority. Subsequent 1136 numbers specify a decreasing ordinal priority. A value of 9 is the 1137 lowest priority. Other integer values are reserved for future use. 1139 4.4.2. freeBusyStatus 1141 Type: String (optional, default: "busy"). 1143 Specifies how this property should be treated when calculating free- 1144 busy state. The value MUST be one of: 1146 o ""free"": The object should be ignored when calculating whether 1147 the user is busy. 1149 o ""busy"": The object should be included when calculating whether 1150 the user is busy. 1152 4.4.3. privacy 1154 Type: String (optional, default: "public"). 1156 Calendar objects are normally collected together and may be shared 1157 with other users. The privacy property allows the object owner to 1158 indicate that it should not be shared, or should only have the time 1159 information shared but the details withheld. Enforcement of the 1160 restrictions indicated by this property are up to the 1161 implementations. 1163 This property MUST NOT affect the information sent to scheduled 1164 participants; it is only interpreted when the object is shared as 1165 part of a shared calendar. 1167 The value MUST be either one of the following values, registered in a 1168 future RFC, or a vendor-specific value. Vendor specific values MUST 1169 be prefixed with a domain name controlled by the vendor, e.g. 1170 "example.com/topsecret". Any value the client or server doesn't 1171 understand should be preserved but treated as equivalent to 1172 "private". 1174 o "public": The full details of the object are visible to those whom 1175 the object's calendar is shared with. 1177 o "private": The details of the object are hidden; only the basic 1178 time and metadata is shared. The following properties MAY be 1179 shared, any other properties MUST NOT be shared: 1181 * @type 1183 * created 1185 * due 1186 * duration 1188 * estimatedDuration 1190 * freeBusyStatus 1192 * privacy 1194 * recurrenceOverrides. Only patches whose keys are prefixed with 1195 one of the above properties are allowed to be shared. 1197 * sequence 1199 * showWithoutTime 1201 * start 1203 * timeZone 1205 * timeZones 1207 * uid 1209 * updated 1211 o "secret": The object is hidden completely (as though it did not 1212 exist) when the object is shared. 1214 4.4.4. replyTo 1216 Type: String[String] (optional). 1218 Represents methods by which participants may submit their RSVP 1219 response to the organizer of the calendar object. The keys in the 1220 property value are the available methods and MUST only contain ASCII 1221 alphanumeric characters (A-Za-z0-9). The value is a URI to use that 1222 method. Future methods may be defined in future specifications; a 1223 calendar client MUST ignore any method it does not understand, but 1224 MUST preserve the method key and URI. This property MUST be omitted 1225 if no method is defined (rather than an empty object). If this 1226 property is set, the "participants" property of this calendar object 1227 MUST contain at least one participant. 1229 The following methods are defined: 1231 o "imip": The organizer accepts an iMIP [RFC6047] response at this 1232 email address. The value MUST be a "mailto:" URI. 1234 o "web": Opening this URI in a web browser will provide the user 1235 with a page where they can submit a reply to the organizer. 1237 o "other": The organizer is identified by this URI but the method 1238 how to submit the RSVP is undefined. 1240 4.4.5. participants 1242 Type: String[Participant] (optional). 1244 A map of participant identifiers to participants, describing their 1245 participation in the calendar object. 1247 If this property is set, then the "replyTo" property of this calendar 1248 object MUST define at least one reply method. 1250 A Participant object has the following properties: 1252 o name: String (optional). The display name of the participant 1253 (e.g. "Joe Bloggs"). 1255 o email: String (optional). The email address for the participant. 1257 o sendTo: String[String]. Represents methods by which the 1258 participant may receive the invitation and updates to the calendar 1259 object. 1261 The keys in the property value are the available methods and MUST 1262 only contain ASCII alphanumeric characters (A-Za-z0-9). The value 1263 is a URI to use that method. Future methods may be defined in 1264 future specifications; a calendar client MUST ignore any method it 1265 does not understand, but MUST preserve the method key and URI. 1266 This property MUST be omitted if no method is defined (rather than 1267 an empty object). 1269 The following methods are defined: 1271 * "imip": The participant accepts an iMIP [RFC6047] request at 1272 this email address. The value MUST be a "mailto:" URI. It MAY 1273 be different from the value of the participant's "email" 1274 property. 1276 * "other": The participant is identified by this URI but the 1277 method how to submit the invitation or update is undefined. 1279 o kind: String (optional). What kind of entity this participant is, 1280 if known. 1282 This MUST be either one of the following values, registered in a 1283 future RFC, or a vendor-specific value. Any value the client or 1284 server doesn't understand should be treated the same as if this 1285 property is omitted. 1287 * "individual": a single person 1289 * "group": a collection of people invited as a whole 1291 * "resource": a non-human resource, e.g. a projector 1293 * "location": a physical location involved in the calendar object 1294 that needs to be scheduled, e.g. a conference room. 1296 o roles: String[Boolean]. A set of roles that this participant 1297 fulfills. 1299 At least one role MUST be specified for the participant. The keys 1300 in the set MUST be either one of the following values, registered 1301 in a future RFC, or a vendor-specific value: 1303 * "owner": The participant is an owner of the object. 1305 * "attendee": The participant is an attendee of the calendar 1306 object. 1308 * "chair": The participant is in charge of the calendar object 1309 when it occurs. 1311 The value for each key in the set MUST be "true". Roles that are 1312 unknown to the implementation MUST be preserved and MAY be 1313 ignored. 1315 o locationId: String (optional). The location at which this 1316 participant is expected to be attending. 1318 If the value does not correspond to any location id in the 1319 "locations" property of the instance, this MUST be treated the 1320 same as if the participant's locationId were omitted. 1322 o participationStatus: String (optional, default: "needs-action"). 1323 The participation status, if any, 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: 1328 * "needs-action": No status yet set by the participant. 1330 * "accepted": The invited participant will participate. 1332 * "declined": The invited participant will not participate. 1334 * "tentative": The invited participant may participate. 1336 o attendance: String (optional, default: "required"). The required 1337 attendance of this participant. 1339 The value MUST be either one of the following values, registered 1340 in a future RFC, or a vendor-specific value. Any value the client 1341 or server doesn't understand should be treated the same as 1342 "required". 1344 * "none": Indicates a participant who is copied for information 1345 purposes only. 1347 * "optional": Indicates a participant whose attendance is 1348 optional. 1350 * "required": Indicates a participant whose attendance is 1351 required. 1353 o expectReply: Boolean (optional, default: "false"). If true, the 1354 organizer is expecting the participant to notify them of their 1355 status. 1357 o scheduleSequence: Number (optional, default: "0"). The sequence 1358 number of the last response from the participant. If defined, 1359 this MUST be a non-negative integer. 1361 This can be used to determine whether the participant has sent a 1362 new RSVP following significant changes to the calendar object, and 1363 to determine if future responses are responding to a current or 1364 older view of the data. 1366 o scheduleUpdated: UTCDate (optional). The "updated" property of 1367 the last iMIP response from the participant. 1369 This can be compared to the "updated" property timestamp in future 1370 iMIP responses to determine if the response is older or newer than 1371 the current data. 1373 o invitedBy: String (optional). The participant id of the 1374 participant who invited this one, if known. 1376 o delegatedTo: String[Boolean] (optional). A set of participant ids 1377 that this participant has delegated their participation to. Each 1378 key in the set MUST be the identifier of a participant. The value 1379 for each key in the set MUST be "true". This MUST be omitted if 1380 none (rather than an empty set). 1382 o delegatedFrom: String[Boolean] (optional). A set of participant 1383 ids that this participant is acting as a delegate for. Each key 1384 in the set MUST be the identifier of a participant. The value for 1385 each key in the set MUST be "true". This MUST be omitted if none 1386 (rather than an empty set). 1388 o memberOf: String[Boolean] (optional). A set of group participants 1389 that were invited to this calendar object, which caused this 1390 participant to be invited due to their membership of the group(s). 1391 Each key in the set MUST be the identifier of a participant. The 1392 value for each key in the set MUST be "true". This MUST be 1393 omitted if none (rather than an empty set). 1395 o linkIds: String[Boolean] (optional). A set of links to more 1396 information about this participant, for example in vCard format. 1397 The keys in the set MUST be the identifier of a Link object in the 1398 calendar object's "links" property. The value for each key in the 1399 set MUST be "true". This MUST be omitted if none (rather than an 1400 empty set). 1402 4.5. Alerts properties 1404 4.5.1. useDefaultAlerts 1406 Type: Boolean (optional, default: "false"). 1408 If "true", use the user's default alerts and ignore the value of the 1409 "alerts" property. Fetching user defaults is dependent on the API 1410 from which this JSCalendar object is being fetched, and is not 1411 defined in this specification. If an implementation cannot determine 1412 the user's default alerts, or none are set, it MUST process the 1413 alerts property as if useDefaultAlerts is set to "false". 1415 4.5.2. alerts 1417 Type: String[Alert] (optional). 1419 A map of alert identifiers to Alert objects, representing alerts/ 1420 reminders to display or send the user for this calendar object. 1422 An Alert Object has the following properties: 1424 o trigger: OffsetTrigger|UnknownTrigger. Defines when to trigger 1425 the alert. 1427 An *OffsetTrigger* object has the following properties: 1429 * type: String (mandatory). The value of this property MUST be 1430 "offset". 1432 * offset: SignedDuration (mandatory). Defines to trigger the 1433 alert relative to the time property defined in the "relativeTo" 1434 property. If the calendar object does not define a time zone, 1435 the user's default time zone SHOULD be used when determining 1436 the offset, if known. Otherwise, the time zone to use is 1437 implementation specific. 1439 * relativeTo: String (optional, default: "start"). Specifies the 1440 time property which the alert offset is relative to. The value 1441 MUST be one of: 1443 + "start": triggers the alert relative to the start of the 1444 calendar object 1446 + "end": triggers the alert relative to the end/due time of 1447 the calendar object 1449 An *UnknownTrigger* object is an object that contains a *type* 1450 property whose value is not "offset", plus zero or more other 1451 properties. This is for compatibility with client extensions and 1452 future RFCs. Implementations SHOULD NOT trigger for trigger types 1453 they do not understand, but MUST preserve them. 1455 o acknowledged: UTCDate (optional). 1457 When the user has permanently dismissed the alert the client MUST 1458 set this to the current time in UTC. Other clients which sync 1459 this property can then automatically dismiss or suppress duplicate 1460 alerts (alerts with the same alert id that triggered on or before 1461 this date-time). 1463 For a recurring calendar object, the "acknowledged" property of 1464 the parent object MUST be updated, unless the alert is already 1465 overridden in the "recurrenceOverrides" property. 1467 o snoozed: UTCDate (optional). 1469 If the user temporarily dismisses the alert, this is the UTC date- 1470 time after which it should trigger again. Setting this property 1471 on an instance of a recurring calendar object MUST update the 1472 alarm on the top-level object, unless the respective instance 1473 already is defined in "recurrenceOverrides". It MUST NOT generate 1474 an override for the sole use of snoozing an alarm. 1476 o action: String (optional, default: "display"). Describes how to 1477 alert the user. 1479 The value MUST be at most one of the following values, registered 1480 in a future RFC, or a vendor-specific value: 1482 * "display": The alert should be displayed as appropriate for the 1483 current device and user context. 1485 * "email": The alert should trigger an email sent out to the 1486 user, notifying about the alert. This action is typically only 1487 appropriate for server implementations. 1489 4.6. Multilingual properties 1491 4.6.1. localizations 1493 Type: String[PatchObject] (optional). 1495 A map of [RFC5646] language tags to patch objects, which localize the 1496 calendar object into the locale of the respective language tag. 1498 See the description of PatchObject (Section 3.2.4) for the structure 1499 of the PatchObject. The patches are applied to the top-level object. 1500 In addition to all the restrictions on patches specified there, the 1501 pointer also MUST NOT start with one of the following prefixes; any 1502 patch with a such a key MUST be ignored: 1504 o @type 1506 o due 1508 o duration 1510 o freeBusyStatus 1512 o localization 1514 o method 1516 o participants 1518 o prodId 1520 o progress 1522 o relatedTo 1523 o sequence 1525 o start 1527 o status 1529 o timeZone 1531 o uid 1533 o useDefaultAlerts 1535 Note that this specification does not define how to maintain validity 1536 of localized content. For example, a client application changing a 1537 JSCalendar object's title property might also need to update any 1538 localizations of this property. Client implementations SHOULD 1539 provide the means to manage localizations, but how to achieve this is 1540 specific to the application's workflow and requirements. 1542 4.7. Time zone properties 1544 4.7.1. timeZones 1546 Type: String[TimeZone] (optional). 1548 Maps identifiers of custom time zones to their time zone definition. 1549 The following restrictions apply for each key in the map: 1551 o It MUST start with the "/" character (ASCII decimal 47; also see 1552 sections 3.2.19 of [RFC5545] and 3.6. of [RFC7808] for discussion 1553 of the forward slash character in time zone identifiers). 1555 o It MUST be a valid "paramtext" value as specified in section 3.1. 1556 of [RFC5545]. 1558 o At least one other property in the same JSCalendar object MUST 1559 reference a time zone using this identifier (i.e. orphaned time 1560 zones are not allowed). 1562 An identifier need only be unique to this JSCalendar object. 1564 A TimeZone object maps a VTIMEZONE component from iCalendar 1565 ([RFC5545]). A valid time zone MUST define at least one transition 1566 rule in the "standard" or "daylight" property. Its properties are: 1568 o tzId: String (mandatory). The TZID property from iCalendar. 1570 o lastModified: UTCDate (optional). The LAST-MODIFIED property from 1571 iCalendar. 1573 o url: String (optional). The TZURL property from iCalendar. 1575 o validUntil: UTCDate (optional). The TZUNTIL property from 1576 iCalendar specified in [RFC7808]. 1578 o aliases: String[Boolean] (optional). Maps the TZID-ALIAS-OF 1579 properties from iCalendar specified in [RFC7808] to a JSON set of 1580 aliases. The set is represented as an object, with the keys being 1581 the aliases. The value for each key in the set MUST be "true". 1583 o standard: TimeZoneRule[] (optional). The STANDARD sub-components 1584 from iCalendar. The order MUST be preserved during conversion. 1586 o daylight: TimeZoneRule[] (optional). The DAYLIGHT sub-components 1587 from iCalendar. The order MUST be preserved during conversion. 1589 A TimeZoneRule object maps a STANDARD or DAYLIGHT sub-component from 1590 iCalendar, with the restriction that at most one recurrence rule is 1591 allowed per rule. It has the following properties: 1593 o start: LocalDate (mandatory). The DTSTART property from 1594 iCalendar. 1596 o offsetTo: String (mandatory). The TZOFFSETTO property from 1597 iCalendar. 1599 o offsetFrom: String (mandatory). The TZOFFSETFROM property from 1600 iCalendar. 1602 o recurrenceRule: RecurrenceRule (optional). The RRULE property 1603 mapped as specified in Section 4.3.1. During recurrence rule 1604 evaluation, the "until" property value MUST be interpreted as a 1605 local time in the UTC time zone. 1607 o recurrenceDates: LocalDate[Boolean] (optional). Maps the RDATE 1608 properties from iCalendar to a JSON set. The set is represented 1609 as an object, with the keys being the recurrence dates. The value 1610 for each key in the set MUST be "true". 1612 o names: String[Boolean] (optional). Maps the TZNAME properties 1613 from iCalendar to a JSON set. The set is represented as an 1614 object, with the keys being the names. The value for each key in 1615 the set MUST be "true". 1617 o comments: String[] (optional). Maps the COMMENT properties from 1618 iCalendar. The order MUST be preserved during conversion. 1620 5. Type-specific JSCalendar properties 1622 5.1. JSEvent properties 1624 In addition to the common JSCalendar object properties (Section 4) a 1625 JSEvent has the following properties: 1627 5.1.1. start 1629 Type: LocalDate (mandatory). 1631 The date/time the event would start in the event's time zone. 1633 5.1.2. timeZone 1635 Type: String|null (optional, default: "null"). 1637 Identifies the time zone the event is scheduled in, or "null" for 1638 floating time. If omitted, this MUST be presumed to be "null" (i.e. 1639 floating time). Also see Section 3.2.6. 1641 5.1.3. duration 1643 Type: Duration (optional, default: "PT0S"). 1645 The zero or positive duration of the event in the event's start time 1646 zone. The same rules as for the iCalendar DURATION value type 1647 ([RFC5545]) apply: The duration of a week or a day in hours/minutes/ 1648 seconds may vary if it overlaps a period of discontinuity in the 1649 event's time zone, for example a change from standard time to 1650 daylight-savings time. Leap seconds MUST NOT be considered when 1651 computing an exact duration. When computing an exact duration, the 1652 greatest order time components MUST be added first, that is, the 1653 number of days MUST be added first, followed by the number of hours, 1654 number of minutes, and number of seconds. Fractional seconds MUST be 1655 added last. 1657 A JSEvent MAY involve start and end locations that are in different 1658 time zones (e.g. a trans-continental flight). This can be expressed 1659 using the "relativeTo" and "timeZone" properties of the JSEvent's 1660 "location" objects. 1662 5.1.4. status 1664 Type: String (optional, default: "confirmed"). 1666 The scheduling status (Section 4.4) of a JSEvent. If set, it MUST be 1667 one of: 1669 o "confirmed": Indicates the event is definite. 1671 o "cancelled": Indicates the event is cancelled. 1673 o "tentative": Indicates the event is tentative. 1675 5.2. JSTask properties 1677 In addition to the common JSCalendar object properties (Section 4) a 1678 JSTask has the following properties: 1680 5.2.1. due 1682 Type: LocalDate (optional). 1684 The date/time the task is due in the task's time zone. 1686 5.2.2. start 1688 Type: LocalDate (optional). 1690 The date/time the task should start in the task's time zone. 1692 5.2.3. timeZone 1694 Type: String|null (optional, default: "null"). 1696 Identifies the time zone the task is scheduled in, or "null" for 1697 floating time. If omitted, this MUST be presumed to be "null" (i.e. 1698 floating time). Also see Section 3.2.6. 1700 5.2.4. estimatedDuration 1702 Type: Duration (optional). 1704 Specifies the estimated positive duration of time the task takes to 1705 complete. 1707 5.2.5. statusUpdatedAt 1709 Type: UTCDate (optional). 1711 Specifies the date/time the task status properties was last updated. 1713 If the task is recurring and has future instances, a client may want 1714 to keep track of the last status update timestamp of a specific task 1715 recurrence, but leave other instances unchanged. One way to achieve 1716 this is by overriding the statusUpdatedAt property in the task 1717 "recurrenceOverrides" property. However, this could produce a long 1718 list of timestamps for regularly recurring tasks. An alternative 1719 approach is to split the JSTask into a current, single instance of 1720 JSTask with this instance status update time and a future recurring 1721 instance. Also see Section 4.1.3 on splitting. 1723 5.2.6. progress 1725 In addition to the common properties of a Participant object 1726 (Section 4.4.5), a Participant within a JSTask supports the following 1727 property: 1729 o progress: ParticipantProgress (optional). The progress of the 1730 participant for this task, if known. This property MUST NOT be 1731 set if the "participationStatus" of this participant is any other 1732 value but "accepted". 1734 A ParticipantProgress object has the following properties: 1736 o status: String (mandatory). Describes the completion status of 1737 the participant's progress. 1739 The value MUST be at most one of the following values, registered 1740 in a future RFC, or a vendor-specific value: 1742 * "completed": The participant completed their task. 1744 * "in-process": The participant has started this task. 1746 * "failed": The participant failed to complete their task. 1748 o timestamp: UTCDate (mandatory). Describes the last time when the 1749 participant progress got updated. 1751 5.2.7. status 1753 Type: String (optional). 1755 Defines the overall status of this task. If omitted, the default 1756 status (Section 4.4) of a JSTask is defined as follows (in order of 1757 evaluation): 1759 o "completed": if the "status" property value of all participant 1760 progresses is "completed". 1762 o "failed": if at least one "status" property value of the 1763 participant progresses is "failed". 1765 o "in-process": if at least one "status" property value of the 1766 participant progresses is "in-process". 1768 o "needs-action": If none of the other criteria match. 1770 If set, it MUST be one of: 1772 o "needs-action": Indicates the task needs action. 1774 o "completed": Indicates the task is completed. 1776 o "in-process": Indicates the task is in process. 1778 o "cancelled": Indicates the task is cancelled. 1780 o "pending": Indicates the task has been created and accepted for 1781 processing, but not yet started. 1783 o "failed": Indicates the task failed. 1785 5.3. JSGroup properties 1787 JSGroup supports the following JSCalendar properties (Section 4): 1789 o @type 1791 o uid 1793 o created 1795 o updated 1797 o categories 1798 o keywords 1800 o name 1802 o description 1804 o color 1806 o links 1808 as well as the following JSGroup-specific properties: 1810 5.3.1. entries 1812 Type: String[JSTask|JSEvent] (mandatory). 1814 A collection of group members. This is represented as a map of the 1815 "uid" property value to the JSCalendar object member having that uid. 1816 Implementations MUST ignore entries of unknown type. 1818 5.3.2. source 1820 Type: String (optional). 1822 The source from which updated versions of this group may be retrieved 1823 from. The value MUST be a URI. 1825 6. JSCalendar object examples 1827 The following examples illustrate several aspects of the JSCalendar 1828 data model and format. The examples may omit mandatory or additional 1829 properties, which is indicated by a placeholder property with key 1830 "...". While most of the examples use calendar event objects, they 1831 are also illustrative for tasks. 1833 6.1. Simple event 1835 This example illustrates a simple one-time event. It specifies a 1836 one-time event that begins on January 15, 2018 at 1pm New York local 1837 time and ends after 1 hour. 1839 { 1840 "@type": "jsevent", 1841 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 1842 "updated": "2018-01-15T18:00:00Z", 1843 "title": "Some event", 1844 "start": "2018-01-15T13:00:00", 1845 "timeZone": "America/New_York", 1846 "duration": "PT1H" 1847 } 1849 6.2. Simple task 1851 This example illustrates a simple task for a plain to-do item. 1853 { 1854 "@type": "jstask", 1855 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 1856 "updated": "2018-01-15T18:00:00Z", 1857 "title": "Do something" 1858 } 1860 6.3. Simple group 1862 This example illustrates a simple calendar object group that contains 1863 an event and a task. 1865 { 1866 "@type": "jsgroup", 1867 "uid": "2a358cee-6489-4f14-a57f-c104db4dc343", 1868 "updated": "2018-01-15T18:00:00Z", 1869 "name": "A simple group", 1870 "entries": [ 1871 { 1872 "@type": "jsevent", 1873 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 1874 "updated": "2018-01-15T18:00:00Z", 1875 "title": "Some event", 1876 "start": "2018-01-15T13:00:00", 1877 "timeZone": "America/New_York", 1878 "duration": "PT1H" 1879 }, 1880 { 1881 "@type": "jstask", 1882 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 1883 "updated": "2018-01-15T18:00:00Z", 1884 "title": "Do something" 1885 } 1886 ] 1887 } 1889 6.4. All-day event 1891 This example illustrates an event for an international holiday. It 1892 specifies an all-day event on April 1 that occurs every year since 1893 the year 1900. 1895 { 1896 "...": "", 1897 "title": "April Fool's Day", 1898 "showWithoutTime": true, 1899 "start": "1900-04-01T00:00:00", 1900 "duration": "P1D", 1901 "recurrenceRule": { 1902 "frequency": "yearly" 1903 } 1904 } 1906 6.5. Task with a due date 1908 This example illustrates a task with a due date. It is a reminder to 1909 buy groceries before 6pm Vienna local time on January 19, 2018. The 1910 calendar user expects to need 1 hour for shopping. 1912 { 1913 "...": "", 1914 "title": "Buy groceries", 1915 "due": "2018-01-19T18:00:00", 1916 "timeZone": "Europe/Vienna", 1917 "estimatedDuration": "PT1H" 1918 } 1920 6.6. Event with end time-zone 1922 This example illustrates the use of end time-zones by use of an 1923 international flight. The flight starts on April 1, 2018 at 9am in 1924 Berlin local time. The duration of the flight is scheduled at 10 1925 hours 30 minutes. The time at the flights destination is in the same 1926 time-zone as Tokyo. Calendar clients could use the end time-zone to 1927 display the arrival time in Tokyo local time and highlight the time- 1928 zone difference of the flight. The location names can serve as input 1929 for navigation systems. 1931 { 1932 "...": "", 1933 "title": "Flight XY51 to Tokyo", 1934 "start": "2018-04-01T09:00:00", 1935 "timeZone": "Europe/Berlin", 1936 "duration": "PT10H30M", 1937 "locations": { 1938 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 1939 "rel": "start", 1940 "name": "Frankfurt Airport (FRA)" 1941 }, 1942 "c2c7ac67-dc13-411e-a7d4-0780fb61fb08": { 1943 "rel": "end", 1944 "name": "Narita International Airport (NRT)", 1945 "timeZone": "Asia/Tokyo" 1946 } 1947 } 1948 } 1950 6.7. Floating-time event (with recurrence) 1952 This example illustrates the use of floating-time. Since January 1, 1953 2018, a calendar user blocks 30 minutes every day to practice Yoga at 1954 7am local time, in whatever time-zone the user is located on that 1955 date. 1957 { 1958 "...": "", 1959 "title": "Yoga", 1960 "start": "2018-01-01T07:00:00", 1961 "duration": "PT30M", 1962 "recurrenceRule": { 1963 "frequency": "daily" 1964 } 1965 } 1967 6.8. Event with multiple locations and localization 1969 This example illustrates an event that happens at both a physical and 1970 a virtual location. Fans can see a live convert on premises or 1971 online. The event title and descriptions are localized. 1973 { 1974 "...": "", 1975 "title": "Live from Music Bowl: The Band", 1976 "description": "Go see the biggest music event ever!", 1977 "locale": "en", 1978 "start": "2018-07-04T17:00:00", 1979 "timeZone": "America/New_York", 1980 "duration": "PT3H", 1981 "locations": { 1982 "c0503d30-8c50-4372-87b5-7657e8e0fedd": { 1983 "name": "The Music Bowl", 1984 "description": "Music Bowl, Central Park, New York", 1985 "coordinates": "geo:40.7829,73.9654" 1986 } 1987 }, 1988 "virtualLocations": { 1989 "6f3696c6-1e07-47d0-9ce1-f50014b0041a": { 1990 "name": "Free live Stream from Music Bowl", 1991 "uri": "https://stream.example.com/the_band_2018" 1992 } 1993 }, 1994 "localizations": { 1995 "de": { 1996 "title": "Live von der Music Bowl: The Band!", 1997 "description": "Schau dir das groesste Musikereignis an!", 1998 "virtualLocations/6f3696c6-1e07-47d0-9ce1-f50014b0041a/name": 1999 "Gratis Live-Stream aus der Music Bowl" 2000 } 2001 } 2002 } 2004 6.9. Recurring event with overrides 2006 This example illustrates the use of recurrence overrides. A math 2007 course at a University is held for the first time on January 8, 2018 2008 at 9am London time and occurs every week until June 25, 2018. Each 2009 lecture lasts for one hour and 30 minutes and is located at the 2010 Mathematics department. This event has exceptional occurrences: at 2011 the last occurrence of the course is an exam, which lasts for 2 hours 2012 and starts at 10am. Also, the location of the exam differs from the 2013 usual location. On April 2 no course is held. On January 5 at 2pm 2014 is an optional introduction course, that occurs before the first 2015 regular lecture. 2017 { 2018 "...": "", 2019 "title": "Calculus I", 2020 "start": "2018-01-08T09:00:00", 2021 "timeZone": "Europe/London", 2022 "duration": "PT1H30M", 2023 "locations": { 2024 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2025 "title": "Math lab room 1", 2026 "description": "Math Lab I, Department of Mathematics" 2027 } 2028 }, 2029 "recurrenceRule": { 2030 "frequency": "weekly", 2031 "until": "2018-06-25T09:00:00" 2032 }, 2033 "recurrenceOverrides": { 2034 "2018-01-05T14:00:00": { 2035 "title": "Introduction to Calculus I (optional)" 2036 }, 2037 "2018-04-02T09:00:00": { 2038 "excluded": "true" 2039 }, 2040 "2018-06-25T09:00:00": { 2041 "title": "Calculus I Exam", 2042 "start": "2018-06-25T10:00:00", 2043 "duration": "PT2H", 2044 "locations": { 2045 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2046 "title": "Big Auditorium", 2047 "description": "Big Auditorium, Other Road" 2048 } 2049 } 2050 } 2051 } 2052 } 2054 6.10. Recurring event with participants 2056 This example illustrates scheduled events. A team meeting occurs 2057 every week since January 8, 2018 at 9am Johannesburg time. The event 2058 owner also chairs the event. Participants meet in a virtual meeting 2059 room. An attendee has accepted the invitation, but on March 8, 2018 2060 he is unavailable and declined participation for this occurrence. 2062 { 2063 "...": "", 2064 "title": "FooBar team meeting", 2065 "start": "2018-01-08T09:00:00", 2066 "timeZone": "Africa/Johannesburg", 2067 "duration": "PT1H", 2068 "virtualLocations": { 2069 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2070 "name": "ChatMe meeting room", 2071 "uri": "https://chatme.example.com?id=1234567" 2072 } 2073 }, 2074 "recurrenceRule": { 2075 "frequency": "weekly" 2076 }, 2077 "replyTo": { 2078 "imip": "mailto:6489-4f14-a57f-c1@schedule.example.com" 2079 }, 2080 "participants": { 2081 "dG9tQGZvb2Jhci5leGFtcGxlLmNvbQ": { 2082 "name": "Tom Tool", 2083 "email": "tom@foobar.example.com", 2084 "sendTo": { 2085 "imip": "mailto:6489-4f14-a57f-c1@calendar.example.com" 2086 }, 2087 "participationStatus": "accepted", 2088 "roles": { 2089 "attendee": true 2090 } 2091 }, 2092 "em9lQGZvb2Jhci5leGFtcGxlLmNvbQ": { 2093 "name": "Zoe Zelda", 2094 "email": "zoe@foobar.example.com", 2095 "sendTo": { 2096 "imip": "mailto:zoe@foobar.example.com" 2097 }, 2098 "participationStatus": "accepted", 2099 "roles": { 2100 "owner": true, 2101 "attendee": true, 2102 "chair": true 2103 } 2104 }, 2105 "...": "" 2106 }, 2107 "recurrenceOverrides": { 2108 "2018-03-08T09:00:00": { 2109 "participants/dG9tQGZvb2Jhci5leGFtcGxlLmNvbQ/participationStatus": 2110 "declined" 2111 } 2112 } 2114 } 2116 7. Security Considerations 2118 The use of JSON as a format does have its own inherent security risks 2119 as discussed in Section 12 of [RFC8259]. Even though JSON is 2120 considered a safe subset of JavaScript, it should be kept in mind 2121 that a flaw in the parser processing JSON could still impose a 2122 threat, which doesn't arise with conventional iCalendar data. 2124 With this in mind, a parser for JSON data aware of the security 2125 implications should be used for the format described in this 2126 document. For example, the use of JavaScript's "eval()" function is 2127 considered an unacceptable security risk, as described in Section 12 2128 of[RFC8259]. A native parser with full awareness of the JSON format 2129 should be preferred. 2131 Several JSCalendar properties contain URIs as values, and processing 2132 these properties requires extra care. Section 7 of [RFC3986] 2133 discusses security risk related to URIs. 2135 8. IANA Considerations 2137 This document defines a MIME media type for use with JSCalendar data 2138 formatted in JSON. 2140 Type name: application 2142 Subtype name: jscalendar+json 2144 Required parameters: type 2146 The "type" parameter conveys the type of the JSCalendar data in 2147 the body part, with the value being one of "jsevent", "jstask", or 2148 "jsgroup". The parameter MUST NOT occur more than once. It MUST 2149 match the value of the "@type" property of the JSON-formatted 2150 JSCalendar object in the body. 2152 Optional parameters: none 2154 Encoding considerations: Same as encoding considerations of 2155 application/json as specified in RFC8529, Section 11 [RFC8259]. 2157 Security considerations: See Section 7 of this document. 2159 Interoperability considerations: This media type provides an 2160 alternative to iCalendar, jCal and proprietary JSON-based 2161 calendaring data formats. 2163 Published specification: This specification. 2165 Applications that use this media type: Applications that currently 2166 make use of the text/calendar and application/calendar+json media 2167 types can use this as an alternative. Similarly, applications 2168 that use the application/json media type to transfer calendaring 2169 data can use this to further specify the content. 2171 Fragment identifier considerations: N/A 2173 Additional information: 2175 Magic number(s): N/A 2177 File extensions(s): N/A 2179 Macintosh file type code(s): N/A 2181 Person & email address to contact for further 2182 information: 2183 calext@ietf.org 2185 Intended usage: COMMON 2187 Restrictions on usage: N/A 2189 Author: See the "Author's Address" section of this document. 2191 Change controller: IETF 2193 9. Acknowledgments 2195 The authors would like to thank the members of CalConnect for their 2196 valuable contributions. This specification originated from the work 2197 of the API technical committee of CalConnect, the Calendaring and 2198 Scheduling Consortium. 2200 10. References 2202 10.1. Normative References 2204 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2205 Requirement Levels", BCP 14, RFC 2119, 2206 DOI 10.17487/RFC2119, March 1997, 2207 . 2209 [RFC2392] Levinson, E., "Content-ID and Message-ID Uniform Resource 2210 Locators", RFC 2392, DOI 10.17487/RFC2392, August 1998, 2211 . 2213 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 2214 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 2215 . 2217 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 2218 Resource Identifier (URI): Generic Syntax", STD 66, 2219 RFC 3986, DOI 10.17487/RFC3986, January 2005, 2220 . 2222 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 2223 Unique IDentifier (UUID) URN Namespace", RFC 4122, 2224 DOI 10.17487/RFC4122, July 2005, 2225 . 2227 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data 2228 Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006, 2229 . 2231 [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault, 2232 "Calendaring Extensions to WebDAV (CalDAV)", RFC 4791, 2233 DOI 10.17487/RFC4791, March 2007, 2234 . 2236 [RFC5545] Desruisseaux, B., Ed., "Internet Calendaring and 2237 Scheduling Core Object Specification (iCalendar)", 2238 RFC 5545, DOI 10.17487/RFC5545, September 2009, 2239 . 2241 [RFC5546] Daboo, C., Ed., "iCalendar Transport-Independent 2242 Interoperability Protocol (iTIP)", RFC 5546, 2243 DOI 10.17487/RFC5546, December 2009, 2244 . 2246 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 2247 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 2248 September 2009, . 2250 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 2251 Identifier for Geographic Locations ('geo' URI)", 2252 RFC 5870, DOI 10.17487/RFC5870, June 2010, 2253 . 2255 [RFC6047] Melnikov, A., Ed., "iCalendar Message-Based 2256 Interoperability Protocol (iMIP)", RFC 6047, 2257 DOI 10.17487/RFC6047, December 2010, 2258 . 2260 [RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type 2261 Specifications and Registration Procedures", BCP 13, 2262 RFC 6838, DOI 10.17487/RFC6838, January 2013, 2263 . 2265 [RFC6901] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., 2266 "JavaScript Object Notation (JSON) Pointer", RFC 6901, 2267 DOI 10.17487/RFC6901, April 2013, 2268 . 2270 [RFC7265] Kewisch, P., Daboo, C., and M. Douglass, "jCal: The JSON 2271 Format for iCalendar", RFC 7265, DOI 10.17487/RFC7265, May 2272 2014, . 2274 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 2275 DOI 10.17487/RFC7493, March 2015, 2276 . 2278 [RFC7529] Daboo, C. and G. Yakushev, "Non-Gregorian Recurrence Rules 2279 in the Internet Calendaring and Scheduling Core Object 2280 Specification (iCalendar)", RFC 7529, 2281 DOI 10.17487/RFC7529, May 2015, 2282 . 2284 [RFC7808] Douglass, M. and C. Daboo, "Time Zone Data Distribution 2285 Service", RFC 7808, DOI 10.17487/RFC7808, March 2016, 2286 . 2288 [RFC7986] Daboo, C., "New Properties for iCalendar", RFC 7986, 2289 DOI 10.17487/RFC7986, October 2016, 2290 . 2292 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 2293 Interchange Format", STD 90, RFC 8259, 2294 DOI 10.17487/RFC8259, December 2017, 2295 . 2297 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 2298 DOI 10.17487/RFC8288, October 2017, 2299 . 2301 10.2. Informative References 2303 [MIME] "IANA Media Types", . 2306 10.3. URIs 2308 [1] https://www.iana.org/time-zones 2310 [2] https://www.iana.org/assignments/link-relations/link- 2311 relations.xhtml 2313 [3] https://www.w3.org/TR/2011/REC-css3-color-20110607/#svg-color 2315 Authors' Addresses 2317 Neil Jenkins 2318 FastMail 2319 PO Box 234 2320 Collins St West 2321 Melbourne VIC 8007 2322 Australia 2324 Email: neilj@fastmailteam.com 2325 URI: https://www.fastmail.com 2327 Robert Stepanek 2328 FastMail 2329 PO Box 234 2330 Collins St West 2331 Melbourne VIC 8007 2332 Australia 2334 Email: rsto@fastmailteam.com 2335 URI: https://www.fastmail.com