idnits 2.17.1 draft-ietf-calext-jscalendar-17.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 29, 2019) is 1763 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 2307 == Missing Reference: 'Relation' is mentioned on line 497, but not defined == Missing Reference: 'Boolean' is mentioned on line 1611, but not defined == Missing Reference: 'Location' is mentioned on line 617, but not defined == Missing Reference: 'VirtualLocation' is mentioned on line 661, but not defined == Missing Reference: 'Link' is mentioned on line 685, but not defined -- Looks like a reference, but probably isn't: '2' on line 2309 -- Looks like a reference, but probably isn't: '3' on line 2312 == Missing Reference: 'PatchObject' is mentioned on line 1492, but not defined == Missing Reference: 'String' is mentioned on line 1256, but not defined == Missing Reference: 'Participant' is mentioned on line 1241, but not defined == Missing Reference: 'Alert' is mentioned on line 1416, but not defined == Missing Reference: 'TimeZone' is mentioned on line 1545, 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 31, 2019 June 29, 2019 7 JSCalendar: A JSON representation of calendar data 8 draft-ietf-calext-jscalendar-17 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 31, 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. UTCDateTime . . . . . . . . . . . . . . . . . . . . . 7 66 3.2.2. LocalDateTime . . . . . . . . . . . . . . . . . . . . 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. UTCDateTime 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 offset MUST be the character 306 "Z". Fractional second values MUST NOT be included unless non-zero 307 and MUST NOT have trailing zeros, to ensure there is only a single 308 representation for 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. LocalDateTime 318 This is a date-time string _with no time zone/offset information_. 319 It is otherwise in the same format as UTCDateTime, including 320 fractional 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 LocalDateTime with comes from an associated property, or if no 323 time zone is associated it defines _floating time_. Floating date- 324 times are not tied to any specific time zone. Instead, they occur in 325 every time zone at the same wall-clock time (as opposed to the same 326 instant 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: UTCDateTime (optional). 554 The date and time this object was initially created. 556 4.1.6. updated 558 Type: UTCDateTime (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). The human-readable name of the location. 627 o description: String (optional). Human-readable, plain-text 628 instructions for accessing this location. This may be an address, 629 set of directions, door access code, etc. 631 o relativeTo: String (optional). The relation type of this location 632 to the JSCalendar object. 634 This MUST be either one of the following values, registered in a 635 future RFC, or a vendor-specific value. Any value the client or 636 server doesn't understand should be treated the same as if this 637 property is omitted. 639 * "start": The JSCalendar object starts at this location. 641 * "end": The JSCalendar object ends at this location. 643 o timeZone: String (optional). A time zone for this location. Also 644 see Section 3.2.6. 646 o coordinates: String (optional). An [RFC5870] "geo:" URI for the 647 location. 649 o linkIds: String[Boolean] (optional). A set of link ids for links 650 to alternate representations of this location. Each key in the 651 set MUST be the identifier of a Link object defined in the "links" 652 property of this calendar object. The value for each key in the 653 set MUST be "true". This MUST be omitted if none (rather than an 654 empty set). 656 For example, an alternative representation could be in vCard 657 format. 659 4.2.6. virtualLocations 661 Type: String[VirtualLocation] (optional). 663 A map of identifiers to VirtualLocation objects, representing virtual 664 locations, such as video conferences or chat rooms, associated with 665 the object. 667 A VirtualLocation object has the following properties. 669 o name: String (optional, default: empty String). The human- 670 readable name of the virtual location. 672 o description: String (optional). Human-readable plain-text 673 instructions for accessing this location. This may be an address, 674 set of directions, door access code, etc. 676 o uri: String (mandatory). A URI that represents how to connect to 677 this virtual location. 679 This may be a telephone number (represented as 680 "tel:+1-555-555-555") for a teleconference, a web address for 681 online chat, or any custom URI. 683 4.2.7. links 685 Type: String[Link] (optional). 687 A map of link identifiers to Link objects, representing external 688 resources associated with the object. 690 A Link object has the following properties: 692 o href: String (mandatory). A URI from which the resource may be 693 fetched. 695 This MAY be a "data:" URL, but it is recommended that the file be 696 hosted on a server to avoid embedding arbitrarily large data in 697 JSCalendar object instances. 699 o cid: String (optional). This MUST be a valid "content-id" value 700 according to the definition of section 2 in [RFC2392]. The 701 identifier MUST be unique within this JSCalendar object Link 702 objects but has no meaning beyond that. Specifically, it MAY be 703 different from the link identifier in the enclosing "links" 704 property. 706 o type: String (optional). The content-type [RFC6838] of the 707 resource, if known. 709 o size: Number (optional). The size, in bytes, of the resource when 710 fully decoded (i.e. the number of bytes in the file the user would 711 download), if known. 713 o rel: String (optional). Identifies the relation of the linked 714 resource to the object. If set, the value MUST be a registered 715 relation type (see [RFC8288] and IANA Link Relations [2]). 717 Links with a rel of "enclosure" SHOULD be considered by the client 718 as attachments for download. 720 Links with a rel of "describedby" SHOULD be considered by the 721 client to be an alternate representation of the description. 723 Links with a rel of "icon" SHOULD be considered by the client to 724 be an image that it MAY use when presenting the calendar data to a 725 user. The "display" property MAY be set to indicate the purpose 726 of this image. 728 o display: String (optional). Describes the intended purpose of a 729 link to an image. If set, the "rel" property MUST be set to 730 "icon". The value MUST be either one of the following values, 731 registered in a future RFC, or a vendor-specific value: 733 * "badge": an image inline with the title of the object 735 * "graphic": a full image replacement for the object itself 737 * "fullsize": an image that is used to enhance the object 739 * "thumbnail": a smaller variant of "fullsize" to be used when 740 space for the image is constrained 742 o title: String (optional). A human-readable plain-text description 743 of the resource. 745 4.2.8. locale 747 Type: String (optional). 749 The [RFC5646] language tag that best describes the locale used for 750 the calendar object, if known. 752 4.2.9. keywords 754 Type: String[Boolean] (optional). 756 A set of keywords or tags that relate to the object. The set is 757 represented as a map, with the keys being the keywords. The value 758 for each key in the map MUST be "true". 760 4.2.10. categories 762 Type: String[Boolean] (optional). 764 A set of categories that relate to the calendar object. The set is 765 represented as a map, with the keys being the categories specified as 766 URIs. The value for each key in the map MUST be "true". 768 In contrast to keywords, categories typically are structured. For 769 example, a vendor owning the domain "example.com" might define the 770 categories "http://example.com/categories/sports/american-football"" 771 and "http://example.com/categories/music/r-b". 773 4.2.11. color 775 Type: String (optional). 777 Specifies a color clients MAY use when displaying this calendar 778 object. The value is a case-insensitive color name taken from the 779 CSS3 set of names, defined in Section 4.3 of W3C.REC- 780 css3-color-20110607 [3] or a CSS3 RGB color hex value. 782 4.3. Recurrence properties 784 4.3.1. recurrenceRule 786 Type: Recurrence (optional). 788 Defines a recurrence rule (repeating pattern) for recurring calendar 789 objects. 791 A Recurrence object is a JSON object mapping of a RECUR value type in 792 iCalendar, see [RFC5545] and[RFC7529]. A JSEvent recurs by applying 793 the recurrence rule to the start date-time. A JSTask recurs by 794 applying the recurrence rule to the start date-time, if defined, 795 otherwise it recurs by the due date-time, if defined. If the task 796 neither defines a start or due date-time, its "recurrenceRule" 797 property value MUST be "null". 799 A Recurrence object has the following properties: 801 o frequency: String (mandatory). This MUST be one of the following 802 values: 804 * "yearly" 806 * "monthly" 808 * "weekly" 810 * "daily" 812 * "hourly" 814 * "minutely" 816 * "secondly" 818 To convert from iCalendar, simply lower-case the FREQ part. 820 o interval: Number (optional, default: "1"). The INTERVAL part from 821 iCalendar. If included, it MUST be an integer "x >= 1". 823 o rscale: String (optional, default: ""gregorian""). The RSCALE 824 part from iCalendar RSCALE [RFC7529], converted to lower-case. 826 o skip: String (optional, default: ""omit""). The SKIP part from 827 iCalendar RSCALE [RFC7529], converted to lower-case. 829 o firstDayOfWeek: String (optional, default: ""mo""). The WKST part 830 from iCalendar, represented as a lower-case abbreviated two-letter 831 English day of the week. If included, it MUST be one of the 832 following values: ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 834 o byDay: NDay[] (optional). An *NDay* object has the following 835 properties: 837 * day: String. The day-of-the-week part of the BYDAY value in 838 iCalendar, lower-cased. MUST be one of the following values: 839 ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 841 * nthOfPeriod: Number (optional). The ordinal part of the BYDAY 842 value in iCalendar (e.g. ""+1"" or ""-3""). If present, rather 843 than representing every occurrence of the weekday defined in 844 the "day" property, it represents only a specific instance 845 within the recurrence period. The value can be positive or 846 negative, but MUST NOT be zero. A negative integer means nth- 847 last of period. 849 o byMonthDay: Number[] (optional). The BYMONTHDAY part from 850 iCalendar. The array MUST have at least one entry if included. 852 o byMonth: String[] (optional). The BYMONTH part from iCalendar. 853 Each entry is a string representation of a number, starting from 854 "1" for the first month in the calendar (e.g. ""1" " means 855 ""January"" with Gregorian calendar), with an optional ""L"" 856 suffix (see [RFC7529]) for leap months (this MUST be upper-case, 857 e.g. ""3L""). The array MUST have at least one entry if included. 859 o byYearDay: Number[] (optional). The BYYEARDAY part from 860 iCalendar. The array MUST have at least one entry if included. 862 o byWeekNo: Number[] (optional). The BYWEEKNO part from iCalendar. 863 The array MUST have at least one entry if included. 865 o byHour: Number[] (optional). The BYHOUR part from iCalendar. The 866 array MUST have at least one entry if included. 868 o byMinute: Number[] (optional). The BYMINUTE part from iCalendar. 869 The array MUST have at least one entry if included. 871 o bySecond: Number[] (optional). The BYSECOND part from iCalendar. 872 The array MUST have at least one entry if included. 874 o bySetPosition: Number[] (optional). The BYSETPOS part from 875 iCalendar. The array MUST have at least one entry if included. 877 o count: Number (optional). The COUNT part from iCalendar. This 878 MUST NOT be included if an "until" property is specified. 880 o until: LocalDateTime (optional). The UNTIL part from iCalendar. 881 This MUST NOT be included if a "count" property is specified. 882 Note: if not specified otherwise for a specific JSCalendar object, 883 this date is presumed to be in the time zone specified in 884 "timeZone". As in iCalendar, the until value bounds the 885 recurrence rule inclusively. 887 A recurrence rule specifies a set of set of date-times for recurring 888 calendar objects. A recurrence rule has the following semantics. 889 Note, wherever "year", "month" or "day of month" is used, this is 890 within the calendar system given by the "rscale" property, which 891 defaults to gregorian if omitted. 893 1. A set of candidates is generated. This is every second within a 894 period defined by the frequency property value: 896 * "yearly": every second from midnight on the 1st day of a year 897 (inclusive) to midnight the 1st day of the following year 898 (exclusive). 900 If skip is not "omit", the calendar system has leap months and 901 there is a byMonth property, generate candidates for the leap 902 months even if they don't occur in this year. 904 If skip is not "omit" and there is a byMonthDay property, 905 presume each month has the maximum number of days any month 906 may have in this calendar system when generating candidates, 907 even if it's more than this month actually has. 909 * "monthly": every second from midnight on the 1st day of a 910 month (inclusive) to midnight on the 1st of the following 911 month (exclusive). 913 If skip is not "omit" and there is a byMonthDay property, 914 presume the month has the maximum number of days any month may 915 have in this calendar system when generating candidates, even 916 if it's more than this month actually has. 918 * "weekly": every second from midnight (inclusive) on the first 919 day of the week (as defined by the firstDayOfWeek property, or 920 Monday if omitted), to midnight 7 days later (exclusive). 922 * "daily": every second from midnight at the start of the day 923 (inclusive) to midnight at the end of the day (exclusive). 925 * "hourly": every second from the beginning of the hour 926 (inclusive) to the beginning of the next hour (exclusive). 928 * "minutely": every second from the beginning of the minute 929 (inclusive) to the beginning of the next minute (exclusive). 931 * "secondly": the second itself, only. 933 2. Each date-time candidate is compared against all of the byX 934 properties of the rule except bySetPosition. If any property in 935 the rule does not match the date-time, it is eliminated. Each 936 byX property is an array; the date-time matches the property if 937 it matches any of the values in the array. The properties have 938 the following semantics: 940 * byMonth: the date-time is in the given month. 942 * byWeekNo: the date-time is in the nth week of the year. 943 Negative numbers mean the nth last week of the year. This 944 corresponds to weeks according to week numbering as defined in 945 ISO.8601.2004, with a week defined as a seven day period, 946 starting on the firstDayOfWeek property value or Monday if 947 omitted. Week number one of the calendar year is the first 948 week that contains at least four days in that calendar year. 950 If the date-time is not valid (this may happen when generating 951 candidates with a skip property in effect), it is always 952 eliminated by this property. 954 * byYearDay: the date-time is on the nth day of year. Negative 955 numbers mean the nth last day of the year. 957 If the date-time is not valid (this may happen when generating 958 candidates with a skip property in effect), it is always 959 eliminated by this property. 961 * byMonthDay: the date-time is on the given day of the month. 962 Negative numbers mean the nth last day of the month. 964 * byDay: the date-time is on the given day of the week. If the 965 day is prefixed by a number, it is the nth occurrence of that 966 day of the week within the month (if frequency is monthly) or 967 year (if frequency is yearly). Negative numbers means nth 968 last occurrence within that period. 970 * byHour: the date-time has the given hour value. 972 * byMinute: the date-time has the given minute value. 974 * bySecond: the date-time has the given second value. 976 If a skip property is defined and is not "omit", there may be 977 candidates that do not correspond to valid dates (e.g. 31st 978 February in the gregorian calendar). In this case, the 979 properties MUST be considered in the order above and: 981 1. After applying the byMonth filter, if the candidate's month 982 is invalid for the given year increment it (if skip is 983 "forward") or decrement it (if skip is "backward") until a 984 valid month is found, incrementing/decrementing the year as 985 well if you pass through the beginning/end of the year. This 986 only applies to calendar systems with leap months. 988 2. After applying the byMonthDay filter, if the day of the month 989 is invalid for the given month and year, change the date to 990 the first day of the next month (if skip == "forward") or the 991 last day of the current month (if skip == "backward"). 993 3. If any valid date produced after applying the skip is already 994 a candidate, eliminate the duplicate. (For example after 995 adjusting, 30th February and 31st February would both become 996 the same "real" date, so one is eliminated as a duplicate.) 998 3. If a bySetPosition property is included, this is now applied to 999 the ordered list of remaining dates (this property specifies the 1000 indexes of date-times to keep; all others should be eliminated. 1001 Negative numbers are indexes from the end of the list, with -1 1002 being the last item). 1004 4. Any date-times before the start date of the event are eliminated 1005 (see below for why this might be needed). 1007 5. If a skip property is included and is not "omit", eliminate any 1008 date-times that have already been produced by previous iterations 1009 of the algorithm. (This is not possible if skip == "omit".) 1011 6. If further dates are required (we have not reached the until 1012 date, or count limit) skip the next (interval - 1) sets of 1013 candidates, then continue from step 1. 1015 When determining the set of occurrence dates for an event or task, 1016 the following extra rules must be applied: 1018 1. The start date-time is always the first occurrence in the 1019 expansion (and is counted if the recurrence is limited by a 1020 "count" property), even if it would normally not match the rule. 1022 2. The first set of candidates to consider is that which would 1023 contain the start date-time. This means the first set may 1024 include candidates before the start; such candidates are 1025 eliminated from the results in step (4) as outlined before. 1027 3. The following properties MUST be implicitly added to the rule 1028 under the given conditions: 1030 * If frequency > "secondly" and no bySecond property: Add a 1031 bySecond property with the sole value being the seconds value 1032 of the start date-time. 1034 * If frequency > "minutely" and no byMinute property: Add a 1035 byMinute property with the sole value being the minutes value 1036 of the start date-time. 1038 * If frequency > "hourly" and no byHour property: Add a byHour 1039 property with the sole value being the hours value of the 1040 start date-time. 1042 * If frequency is "weekly" and no byDay property: Add a byDay 1043 property with the sole value being the day-of-the-week of the 1044 start date-time. 1046 * If frequency is "monthly" and no byDay property and no 1047 byMonthDay property: Add a byMonthDay property with the sole 1048 value being the day-of-the-month of the start date-time. 1050 * If frequency is "yearly" and no byYearDay property: 1052 + if there are no byMonth or byWeekNo properties, and either 1053 there is a byMonthDay property or there is no byDay 1054 property: Add a byMonth property with the sole value being 1055 the month of the start date-time. 1057 + if there is no byMonthDay, byWeekNo or byDay properties: 1058 Add a byMonthDay property with the sole value being the 1059 day-of-the-month of the start date-time. 1061 + if there is a byWeekNo property and no byMonthDay or byDay 1062 properties: Add a byDay property with the sole value being 1063 the day-of-the-week of the start date-time. 1065 4.3.2. recurrenceOverrides 1067 Type: LocalDateTime[PatchObject] (optional). 1069 A map of the recurrence-ids (the date-time of the start of the 1070 occurrence) to an object of patches to apply to the generated 1071 occurrence object. 1073 If the recurrence-id does not match an expanded start date from a 1074 recurrence rule, it is to be treated as an additional occurrence 1075 (like an RDATE from iCalendar). The patch object may often be empty 1076 in this case. 1078 If the patch object defines the "excluded" property value to be 1079 "true", then the recurring calendar object does not occur at the 1080 recurrence-id date-time (like an EXDATE from iCalendar). Such a 1081 patch object MUST NOT patch any other property. 1083 By default, an occurrence inherits all properties from the main 1084 object except the start (or due) date-time, which is shifted to the 1085 new start time of the LocalDateTime key. However, individual 1086 properties of the occurrence can be modified by a patch, or multiple 1087 patches. It is valid to patch the start property value, and this 1088 patch takes precedence over the LocalDateTime key. Both the 1089 LocalDateTime key as well as the patched start date-time may occur 1090 before the original JSCalendar object's start or due date. 1092 A pointer in the PatchObject MUST be ignored if it starts with one of 1093 the following prefixes: 1095 o @type 1097 o uid 1099 o relatedTo 1101 o prodId 1103 o method 1105 o recurrenceRule 1107 o recurrenceOverrides 1109 o replyTo 1111 4.3.3. excluded 1113 Type: Boolean (optional, default: "false"). 1115 Defines if this object is an overridden, excluded instance of a 1116 recurring JSCalendar object (also see Section 4.3.2). If this 1117 property value is "true", this calendar object instance MUST be 1118 removed from the occurrence expansion. The absence of this property 1119 or its default value "false" indicates that this instance MUST be 1120 added to the occurrence expansion. 1122 4.4. Sharing and scheduling properties 1124 4.4.1. priority 1126 Type: Number (optional, default: "0"). 1128 Specifies a priority for the calendar object. This may be used as 1129 part of scheduling systems to help resolve conflicts for a time 1130 period. 1132 The priority is specified as an integer in the range 0 to 9. A value 1133 of 0 specifies an undefined priority. A value of 1 is the highest 1134 priority. A value of 2 is the second highest priority. Subsequent 1135 numbers specify a decreasing ordinal priority. A value of 9 is the 1136 lowest priority. Other integer values are reserved for future use. 1138 4.4.2. freeBusyStatus 1140 Type: String (optional, default: "busy"). 1142 Specifies how this property should be treated when calculating free- 1143 busy state. The value MUST be one of: 1145 o ""free"": The object should be ignored when calculating whether 1146 the user is busy. 1148 o ""busy"": The object should be included when calculating whether 1149 the user is busy. 1151 4.4.3. privacy 1153 Type: String (optional, default: "public"). 1155 Calendar objects are normally collected together and may be shared 1156 with other users. The privacy property allows the object owner to 1157 indicate that it should not be shared, or should only have the time 1158 information shared but the details withheld. Enforcement of the 1159 restrictions indicated by this property are up to the 1160 implementations. 1162 This property MUST NOT affect the information sent to scheduled 1163 participants; it is only interpreted when the object is shared as 1164 part of a shared calendar. 1166 The value MUST be either one of the following values, registered in a 1167 future RFC, or a vendor-specific value. Vendor specific values MUST 1168 be prefixed with a domain name controlled by the vendor, e.g. 1169 "example.com/topsecret". Any value the client or server doesn't 1170 understand should be preserved but treated as equivalent to 1171 "private". 1173 o "public": The full details of the object are visible to those whom 1174 the object's calendar is shared with. 1176 o "private": The details of the object are hidden; only the basic 1177 time and metadata is shared. The following properties MAY be 1178 shared, any other properties MUST NOT be shared: 1180 * @type 1182 * created 1184 * due 1185 * duration 1187 * estimatedDuration 1189 * freeBusyStatus 1191 * privacy 1193 * recurrenceOverrides. Only patches whose keys are prefixed with 1194 one of the above properties are allowed to be shared. 1196 * sequence 1198 * showWithoutTime 1200 * start 1202 * timeZone 1204 * timeZones 1206 * uid 1208 * updated 1210 o "secret": The object is hidden completely (as though it did not 1211 exist) when the object is shared. 1213 4.4.4. replyTo 1215 Type: String[String] (optional). 1217 Represents methods by which participants may submit their RSVP 1218 response to the organizer of the calendar object. The keys in the 1219 property value are the available methods and MUST only contain ASCII 1220 alphanumeric characters (A-Za-z0-9). The value is a URI to use that 1221 method. Future methods may be defined in future specifications; a 1222 calendar client MUST ignore any method it does not understand, but 1223 MUST preserve the method key and URI. This property MUST be omitted 1224 if no method is defined (rather than an empty object). If this 1225 property is set, the "participants" property of this calendar object 1226 MUST contain at least one participant. 1228 The following methods are defined: 1230 o "imip": The organizer accepts an iMIP [RFC6047] response at this 1231 email address. The value MUST be a "mailto:" URI. 1233 o "web": Opening this URI in a web browser will provide the user 1234 with a page where they can submit a reply to the organizer. 1236 o "other": The organizer is identified by this URI but the method 1237 how to submit the RSVP is undefined. 1239 4.4.5. participants 1241 Type: String[Participant] (optional). 1243 A map of participant identifiers to participants, describing their 1244 participation in the calendar object. 1246 If this property is set, then the "replyTo" property of this calendar 1247 object MUST define at least one reply method. 1249 A Participant object has the following properties: 1251 o name: String (optional). The display name of the participant 1252 (e.g. "Joe Bloggs"). 1254 o email: String (optional). The email address for the participant. 1256 o sendTo: String[String]. Represents methods by which the 1257 participant may receive the invitation and updates to the calendar 1258 object. 1260 The keys in the property value are the available methods and MUST 1261 only contain ASCII alphanumeric characters (A-Za-z0-9). The value 1262 is a URI to use that method. Future methods may be defined in 1263 future specifications; a calendar client MUST ignore any method it 1264 does not understand, but MUST preserve the method key and URI. 1265 This property MUST be omitted if no method is defined (rather than 1266 an empty object). 1268 The following methods are defined: 1270 * "imip": The participant accepts an iMIP [RFC6047] request at 1271 this email address. The value MUST be a "mailto:" URI. It MAY 1272 be different from the value of the participant's "email" 1273 property. 1275 * "other": The participant is identified by this URI but the 1276 method how to submit the invitation or update is undefined. 1278 o kind: String (optional). What kind of entity this participant is, 1279 if known. 1281 This MUST be either one of the following values, registered in a 1282 future RFC, or a vendor-specific value. Any value the client or 1283 server doesn't understand should be treated the same as if this 1284 property is omitted. 1286 * "individual": a single person 1288 * "group": a collection of people invited as a whole 1290 * "resource": a non-human resource, e.g. a projector 1292 * "location": a physical location involved in the calendar object 1293 that needs to be scheduled, e.g. a conference room. 1295 o roles: String[Boolean]. A set of roles that this participant 1296 fulfills. 1298 At least one role MUST be specified for the participant. The keys 1299 in the set MUST be either one of the following values, registered 1300 in a future RFC, or a vendor-specific value: 1302 * "owner": The participant is an owner of the object. 1304 * "attendee": The participant is an attendee of the calendar 1305 object. 1307 * "chair": The participant is in charge of the calendar object 1308 when it occurs. 1310 The value for each key in the set MUST be "true". Roles that are 1311 unknown to the implementation MUST be preserved and MAY be 1312 ignored. 1314 o locationId: String (optional). The location at which this 1315 participant is expected to be attending. 1317 If the value does not correspond to any location id in the 1318 "locations" property of the instance, this MUST be treated the 1319 same as if the participant's locationId were omitted. 1321 o participationStatus: String (optional, default: "needs-action"). 1322 The participation status, if any, of this participant. 1324 The value MUST be either one of the following values, registered 1325 in a future RFC, or a vendor-specific value: 1327 * "needs-action": No status yet set by the participant. 1329 * "accepted": The invited participant will participate. 1331 * "declined": The invited participant will not participate. 1333 * "tentative": The invited participant may participate. 1335 o attendance: String (optional, default: "required"). The required 1336 attendance of this participant. 1338 The value MUST be either one of the following values, registered 1339 in a future RFC, or a vendor-specific value. Any value the client 1340 or server doesn't understand should be treated the same as 1341 "required". 1343 * "none": Indicates a participant who is copied for information 1344 purposes only. 1346 * "optional": Indicates a participant whose attendance is 1347 optional. 1349 * "required": Indicates a participant whose attendance is 1350 required. 1352 o expectReply: Boolean (optional, default: "false"). If true, the 1353 organizer is expecting the participant to notify them of their 1354 status. 1356 o scheduleSequence: Number (optional, default: "0"). The sequence 1357 number of the last response from the participant. If defined, 1358 this MUST be a non-negative integer. 1360 This can be used to determine whether the participant has sent a 1361 new RSVP following significant changes to the calendar object, and 1362 to determine if future responses are responding to a current or 1363 older view of the data. 1365 o scheduleUpdated: UTCDateTime (optional). The "updated" property 1366 of the last iMIP response from the participant. 1368 This can be compared to the "updated" property timestamp in future 1369 iMIP responses to determine if the response is older or newer than 1370 the current data. 1372 o invitedBy: String (optional). The participant id of the 1373 participant who invited this one, if known. 1375 o delegatedTo: String[Boolean] (optional). A set of participant ids 1376 that this participant has delegated their participation to. Each 1377 key in the set MUST be the identifier of a participant. The value 1378 for each key in the set MUST be "true". This MUST be omitted if 1379 none (rather than an empty set). 1381 o delegatedFrom: String[Boolean] (optional). A set of participant 1382 ids that this participant is acting as a delegate for. Each key 1383 in the set MUST be the identifier of a participant. The value for 1384 each key in the set MUST be "true". This MUST be omitted if none 1385 (rather than an empty set). 1387 o memberOf: String[Boolean] (optional). A set of group participants 1388 that were invited to this calendar object, which caused this 1389 participant to be invited due to their membership of the group(s). 1390 Each key in the set MUST be the identifier of a participant. The 1391 value for each key in the set MUST be "true". This MUST be 1392 omitted if none (rather than an empty set). 1394 o linkIds: String[Boolean] (optional). A set of links to more 1395 information about this participant, for example in vCard format. 1396 The keys in the set MUST be the identifier of a Link object in the 1397 calendar object's "links" property. The value for each key in the 1398 set MUST be "true". This MUST be omitted if none (rather than an 1399 empty set). 1401 4.5. Alerts properties 1403 4.5.1. useDefaultAlerts 1405 Type: Boolean (optional, default: "false"). 1407 If "true", use the user's default alerts and ignore the value of the 1408 "alerts" property. Fetching user defaults is dependent on the API 1409 from which this JSCalendar object is being fetched, and is not 1410 defined in this specification. If an implementation cannot determine 1411 the user's default alerts, or none are set, it MUST process the 1412 alerts property as if useDefaultAlerts is set to "false". 1414 4.5.2. alerts 1416 Type: String[Alert] (optional). 1418 A map of alert identifiers to Alert objects, representing alerts/ 1419 reminders to display or send the user for this calendar object. 1421 An Alert Object has the following properties: 1423 o trigger: OffsetTrigger|UnknownTrigger. Defines when to trigger 1424 the alert. 1426 An *OffsetTrigger* object has the following properties: 1428 * type: String (mandatory). The value of this property MUST be 1429 "offset". 1431 * offset: SignedDuration (mandatory). Defines to trigger the 1432 alert relative to the time property defined in the "relativeTo" 1433 property. If the calendar object does not define a time zone, 1434 the user's default time zone SHOULD be used when determining 1435 the offset, if known. Otherwise, the time zone to use is 1436 implementation specific. 1438 * relativeTo: String (optional, default: "start"). Specifies the 1439 time property which the alert offset is relative to. The value 1440 MUST be one of: 1442 + "start": triggers the alert relative to the start of the 1443 calendar object 1445 + "end": triggers the alert relative to the end/due time of 1446 the calendar object 1448 An *UnknownTrigger* object is an object that contains a *type* 1449 property whose value is not "offset", plus zero or more other 1450 properties. This is for compatibility with client extensions and 1451 future RFCs. Implementations SHOULD NOT trigger for trigger types 1452 they do not understand, but MUST preserve them. 1454 o acknowledged: UTCDateTime (optional). 1456 When the user has permanently dismissed the alert the client MUST 1457 set this to the current time in UTC. Other clients which sync 1458 this property can then automatically dismiss or suppress duplicate 1459 alerts (alerts with the same alert id that triggered on or before 1460 this date-time). 1462 For a recurring calendar object, the "acknowledged" property of 1463 the parent object MUST be updated, unless the alert is already 1464 overridden in the "recurrenceOverrides" property. 1466 o snoozed: UTCDateTime (optional). 1468 If the user temporarily dismisses the alert, this is the UTC date- 1469 time after which it should trigger again. Setting this property 1470 on an instance of a recurring calendar object MUST update the 1471 alarm on the top-level object, unless the respective instance 1472 already is defined in "recurrenceOverrides". It MUST NOT generate 1473 an override for the sole use of snoozing an alarm. 1475 o action: String (optional, default: "display"). Describes how to 1476 alert the user. 1478 The value MUST be at most one of the following values, registered 1479 in a future RFC, or a vendor-specific value: 1481 * "display": The alert should be displayed as appropriate for the 1482 current device and user context. 1484 * "email": The alert should trigger an email sent out to the 1485 user, notifying about the alert. This action is typically only 1486 appropriate for server implementations. 1488 4.6. Multilingual properties 1490 4.6.1. localizations 1492 Type: String[PatchObject] (optional). 1494 A map of [RFC5646] language tags to patch objects, which localize the 1495 calendar object into the locale of the respective language tag. 1497 See the description of PatchObject (Section 3.2.4) for the structure 1498 of the PatchObject. The patches are applied to the top-level object. 1499 In addition to all the restrictions on patches specified there, the 1500 pointer also MUST NOT start with one of the following prefixes; any 1501 patch with a such a key MUST be ignored: 1503 o @type 1505 o due 1507 o duration 1509 o freeBusyStatus 1511 o localization 1513 o method 1515 o participants 1517 o prodId 1519 o progress 1521 o relatedTo 1522 o sequence 1524 o start 1526 o status 1528 o timeZone 1530 o uid 1532 o useDefaultAlerts 1534 Note that this specification does not define how to maintain validity 1535 of localized content. For example, a client application changing a 1536 JSCalendar object's title property might also need to update any 1537 localizations of this property. Client implementations SHOULD 1538 provide the means to manage localizations, but how to achieve this is 1539 specific to the application's workflow and requirements. 1541 4.7. Time zone properties 1543 4.7.1. timeZones 1545 Type: String[TimeZone] (optional). 1547 Maps identifiers of custom time zones to their time zone definition. 1548 The following restrictions apply for each key in the map: 1550 o It MUST start with the "/" character (ASCII decimal 47; also see 1551 sections 3.2.19 of [RFC5545] and 3.6. of [RFC7808] for discussion 1552 of the forward slash character in time zone identifiers). 1554 o It MUST be a valid "paramtext" value as specified in section 3.1. 1555 of [RFC5545]. 1557 o At least one other property in the same JSCalendar object MUST 1558 reference a time zone using this identifier (i.e. orphaned time 1559 zones are not allowed). 1561 An identifier need only be unique to this JSCalendar object. 1563 A TimeZone object maps a VTIMEZONE component from iCalendar 1564 ([RFC5545]). A valid time zone MUST define at least one transition 1565 rule in the "standard" or "daylight" property. Its properties are: 1567 o tzId: String (mandatory). The TZID property from iCalendar. 1569 o lastModified: UTCDateTime (optional). The LAST-MODIFIED property 1570 from iCalendar. 1572 o url: String (optional). The TZURL property from iCalendar. 1574 o validUntil: UTCDateTime (optional). The TZUNTIL property from 1575 iCalendar specified in [RFC7808]. 1577 o aliases: String[Boolean] (optional). Maps the TZID-ALIAS-OF 1578 properties from iCalendar specified in [RFC7808] to a JSON set of 1579 aliases. The set is represented as an object, with the keys being 1580 the aliases. The value for each key in the set MUST be "true". 1582 o standard: TimeZoneRule[] (optional). The STANDARD sub-components 1583 from iCalendar. The order MUST be preserved during conversion. 1585 o daylight: TimeZoneRule[] (optional). The DAYLIGHT sub-components 1586 from iCalendar. The order MUST be preserved during conversion. 1588 A TimeZoneRule object maps a STANDARD or DAYLIGHT sub-component from 1589 iCalendar, with the restriction that at most one recurrence rule is 1590 allowed per rule. It has the following properties: 1592 o start: LocalDateTime (mandatory). The DTSTART property from 1593 iCalendar. 1595 o offsetTo: String (mandatory). The TZOFFSETTO property from 1596 iCalendar. 1598 o offsetFrom: String (mandatory). The TZOFFSETFROM property from 1599 iCalendar. 1601 o recurrenceRule: RecurrenceRule (optional). The RRULE property 1602 mapped as specified in Section 4.3.1. During recurrence rule 1603 evaluation, the "until" property value MUST be interpreted as a 1604 local time in the UTC time zone. 1606 o recurrenceDates: LocalDateTime[Boolean] (optional). Maps the 1607 RDATE properties from iCalendar to a JSON set. The set is 1608 represented as an object, with the keys being the recurrence 1609 dates. The value for each key in the set MUST be "true". 1611 o names: String[Boolean] (optional). Maps the TZNAME properties 1612 from iCalendar to a JSON set. The set is represented as an 1613 object, with the keys being the names. The value for each key in 1614 the set MUST be "true". 1616 o comments: String[] (optional). Maps the COMMENT properties from 1617 iCalendar. The order MUST be preserved during conversion. 1619 5. Type-specific JSCalendar properties 1621 5.1. JSEvent properties 1623 In addition to the common JSCalendar object properties (Section 4) a 1624 JSEvent has the following properties: 1626 5.1.1. start 1628 Type: LocalDateTime (mandatory). 1630 The date/time the event would start in the event's time zone. 1632 5.1.2. timeZone 1634 Type: String|null (optional, default: "null"). 1636 Identifies the time zone the event is scheduled in, or "null" for 1637 floating time. If omitted, this MUST be presumed to be "null" (i.e. 1638 floating time). Also see Section 3.2.6. 1640 5.1.3. duration 1642 Type: Duration (optional, default: "PT0S"). 1644 The zero or positive duration of the event in the event's start time 1645 zone. The same rules as for the iCalendar DURATION value type 1646 ([RFC5545]) apply: The duration of a week or a day in hours/minutes/ 1647 seconds may vary if it overlaps a period of discontinuity in the 1648 event's time zone, for example a change from standard time to 1649 daylight-savings time. Leap seconds MUST NOT be considered when 1650 computing an exact duration. When computing an exact duration, the 1651 greatest order time components MUST be added first, that is, the 1652 number of days MUST be added first, followed by the number of hours, 1653 number of minutes, and number of seconds. Fractional seconds MUST be 1654 added last. 1656 A JSEvent MAY involve start and end locations that are in different 1657 time zones (e.g. a trans-continental flight). This can be expressed 1658 using the "relativeTo" and "timeZone" properties of the JSEvent's 1659 "location" objects. 1661 5.1.4. status 1663 Type: String (optional, default: "confirmed"). 1665 The scheduling status (Section 4.4) of a JSEvent. If set, it MUST be 1666 one of: 1668 o "confirmed": Indicates the event is definite. 1670 o "cancelled": Indicates the event is cancelled. 1672 o "tentative": Indicates the event is tentative. 1674 5.2. JSTask properties 1676 In addition to the common JSCalendar object properties (Section 4) a 1677 JSTask has the following properties: 1679 5.2.1. due 1681 Type: LocalDateTime (optional). 1683 The date/time the task is due in the task's time zone. 1685 5.2.2. start 1687 Type: LocalDateTime (optional). 1689 The date/time the task should start in the task's time zone. 1691 5.2.3. timeZone 1693 Type: String|null (optional, default: "null"). 1695 Identifies the time zone the task is scheduled in, or "null" for 1696 floating time. If omitted, this MUST be presumed to be "null" (i.e. 1697 floating time). Also see Section 3.2.6. 1699 5.2.4. estimatedDuration 1701 Type: Duration (optional). 1703 Specifies the estimated positive duration of time the task takes to 1704 complete. 1706 5.2.5. statusUpdatedAt 1708 Type: UTCDateTime (optional). 1710 Specifies the date/time the task status properties was last updated. 1712 If the task is recurring and has future instances, a client may want 1713 to keep track of the last status update timestamp of a specific task 1714 recurrence, but leave other instances unchanged. One way to achieve 1715 this is by overriding the statusUpdatedAt property in the task 1716 "recurrenceOverrides" property. However, this could produce a long 1717 list of timestamps for regularly recurring tasks. An alternative 1718 approach is to split the JSTask into a current, single instance of 1719 JSTask with this instance status update time and a future recurring 1720 instance. Also see Section 4.1.3 on splitting. 1722 5.2.6. progress 1724 In addition to the common properties of a Participant object 1725 (Section 4.4.5), a Participant within a JSTask supports the following 1726 property: 1728 o progress: ParticipantProgress (optional). The progress of the 1729 participant for this task, if known. This property MUST NOT be 1730 set if the "participationStatus" of this participant is any other 1731 value but "accepted". 1733 A ParticipantProgress object has the following properties: 1735 o status: String (mandatory). Describes the completion status of 1736 the participant's progress. 1738 The value MUST be at most one of the following values, registered 1739 in a future RFC, or a vendor-specific value: 1741 * "completed": The participant completed their task. 1743 * "in-process": The participant has started this task. 1745 * "failed": The participant failed to complete their task. 1747 o timestamp: UTCDateTime (mandatory). Describes the last time when 1748 the participant progress got updated. 1750 5.2.7. status 1752 Type: String (optional). 1754 Defines the overall status of this task. If omitted, the default 1755 status (Section 4.4) of a JSTask is defined as follows (in order of 1756 evaluation): 1758 o "completed": if the "status" property value of all participant 1759 progresses is "completed". 1761 o "failed": if at least one "status" property value of the 1762 participant progresses is "failed". 1764 o "in-process": if at least one "status" property value of the 1765 participant progresses is "in-process". 1767 o "needs-action": If none of the other criteria match. 1769 If set, it MUST be one of: 1771 o "needs-action": Indicates the task needs action. 1773 o "completed": Indicates the task is completed. 1775 o "in-process": Indicates the task is in process. 1777 o "cancelled": Indicates the task is cancelled. 1779 o "pending": Indicates the task has been created and accepted for 1780 processing, but not yet started. 1782 o "failed": Indicates the task failed. 1784 5.3. JSGroup properties 1786 JSGroup supports the following JSCalendar properties (Section 4): 1788 o @type 1790 o uid 1792 o created 1794 o updated 1796 o categories 1797 o keywords 1799 o name 1801 o description 1803 o color 1805 o links 1807 as well as the following JSGroup-specific properties: 1809 5.3.1. entries 1811 Type: String[JSTask|JSEvent] (mandatory). 1813 A collection of group members. This is represented as a map of the 1814 "uid" property value to the JSCalendar object member having that uid. 1815 Implementations MUST ignore entries of unknown type. 1817 5.3.2. source 1819 Type: String (optional). 1821 The source from which updated versions of this group may be retrieved 1822 from. The value MUST be a URI. 1824 6. JSCalendar object examples 1826 The following examples illustrate several aspects of the JSCalendar 1827 data model and format. The examples may omit mandatory or additional 1828 properties, which is indicated by a placeholder property with key 1829 "...". While most of the examples use calendar event objects, they 1830 are also illustrative for tasks. 1832 6.1. Simple event 1834 This example illustrates a simple one-time event. It specifies a 1835 one-time event that begins on January 15, 2018 at 1pm New York local 1836 time and ends after 1 hour. 1838 { 1839 "@type": "jsevent", 1840 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 1841 "updated": "2018-01-15T18:00:00Z", 1842 "title": "Some event", 1843 "start": "2018-01-15T13:00:00", 1844 "timeZone": "America/New_York", 1845 "duration": "PT1H" 1846 } 1848 6.2. Simple task 1850 This example illustrates a simple task for a plain to-do item. 1852 { 1853 "@type": "jstask", 1854 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 1855 "updated": "2018-01-15T18:00:00Z", 1856 "title": "Do something" 1857 } 1859 6.3. Simple group 1861 This example illustrates a simple calendar object group that contains 1862 an event and a task. 1864 { 1865 "@type": "jsgroup", 1866 "uid": "2a358cee-6489-4f14-a57f-c104db4dc343", 1867 "updated": "2018-01-15T18:00:00Z", 1868 "name": "A simple group", 1869 "entries": [ 1870 { 1871 "@type": "jsevent", 1872 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 1873 "updated": "2018-01-15T18:00:00Z", 1874 "title": "Some event", 1875 "start": "2018-01-15T13:00:00", 1876 "timeZone": "America/New_York", 1877 "duration": "PT1H" 1878 }, 1879 { 1880 "@type": "jstask", 1881 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 1882 "updated": "2018-01-15T18:00:00Z", 1883 "title": "Do something" 1884 } 1885 ] 1886 } 1888 6.4. All-day event 1890 This example illustrates an event for an international holiday. It 1891 specifies an all-day event on April 1 that occurs every year since 1892 the year 1900. 1894 { 1895 "...": "", 1896 "title": "April Fool's Day", 1897 "showWithoutTime": true, 1898 "start": "1900-04-01T00:00:00", 1899 "duration": "P1D", 1900 "recurrenceRule": { 1901 "frequency": "yearly" 1902 } 1903 } 1905 6.5. Task with a due date 1907 This example illustrates a task with a due date. It is a reminder to 1908 buy groceries before 6pm Vienna local time on January 19, 2018. The 1909 calendar user expects to need 1 hour for shopping. 1911 { 1912 "...": "", 1913 "title": "Buy groceries", 1914 "due": "2018-01-19T18:00:00", 1915 "timeZone": "Europe/Vienna", 1916 "estimatedDuration": "PT1H" 1917 } 1919 6.6. Event with end time-zone 1921 This example illustrates the use of end time-zones by use of an 1922 international flight. The flight starts on April 1, 2018 at 9am in 1923 Berlin local time. The duration of the flight is scheduled at 10 1924 hours 30 minutes. The time at the flights destination is in the same 1925 time-zone as Tokyo. Calendar clients could use the end time-zone to 1926 display the arrival time in Tokyo local time and highlight the time- 1927 zone difference of the flight. The location names can serve as input 1928 for navigation systems. 1930 { 1931 "...": "", 1932 "title": "Flight XY51 to Tokyo", 1933 "start": "2018-04-01T09:00:00", 1934 "timeZone": "Europe/Berlin", 1935 "duration": "PT10H30M", 1936 "locations": { 1937 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 1938 "rel": "start", 1939 "name": "Frankfurt Airport (FRA)" 1940 }, 1941 "c2c7ac67-dc13-411e-a7d4-0780fb61fb08": { 1942 "rel": "end", 1943 "name": "Narita International Airport (NRT)", 1944 "timeZone": "Asia/Tokyo" 1945 } 1946 } 1947 } 1949 6.7. Floating-time event (with recurrence) 1951 This example illustrates the use of floating-time. Since January 1, 1952 2018, a calendar user blocks 30 minutes every day to practice Yoga at 1953 7am local time, in whatever time-zone the user is located on that 1954 date. 1956 { 1957 "...": "", 1958 "title": "Yoga", 1959 "start": "2018-01-01T07:00:00", 1960 "duration": "PT30M", 1961 "recurrenceRule": { 1962 "frequency": "daily" 1963 } 1964 } 1966 6.8. Event with multiple locations and localization 1968 This example illustrates an event that happens at both a physical and 1969 a virtual location. Fans can see a live convert on premises or 1970 online. The event title and descriptions are localized. 1972 { 1973 "...": "", 1974 "title": "Live from Music Bowl: The Band", 1975 "description": "Go see the biggest music event ever!", 1976 "locale": "en", 1977 "start": "2018-07-04T17:00:00", 1978 "timeZone": "America/New_York", 1979 "duration": "PT3H", 1980 "locations": { 1981 "c0503d30-8c50-4372-87b5-7657e8e0fedd": { 1982 "name": "The Music Bowl", 1983 "description": "Music Bowl, Central Park, New York", 1984 "coordinates": "geo:40.7829,73.9654" 1985 } 1986 }, 1987 "virtualLocations": { 1988 "6f3696c6-1e07-47d0-9ce1-f50014b0041a": { 1989 "name": "Free live Stream from Music Bowl", 1990 "uri": "https://stream.example.com/the_band_2018" 1991 } 1992 }, 1993 "localizations": { 1994 "de": { 1995 "title": "Live von der Music Bowl: The Band!", 1996 "description": "Schau dir das groesste Musikereignis an!", 1997 "virtualLocations/6f3696c6-1e07-47d0-9ce1-f50014b0041a/name": 1998 "Gratis Live-Stream aus der Music Bowl" 1999 } 2000 } 2001 } 2003 6.9. Recurring event with overrides 2005 This example illustrates the use of recurrence overrides. A math 2006 course at a University is held for the first time on January 8, 2018 2007 at 9am London time and occurs every week until June 25, 2018. Each 2008 lecture lasts for one hour and 30 minutes and is located at the 2009 Mathematics department. This event has exceptional occurrences: at 2010 the last occurrence of the course is an exam, which lasts for 2 hours 2011 and starts at 10am. Also, the location of the exam differs from the 2012 usual location. On April 2 no course is held. On January 5 at 2pm 2013 is an optional introduction course, that occurs before the first 2014 regular lecture. 2016 { 2017 "...": "", 2018 "title": "Calculus I", 2019 "start": "2018-01-08T09:00:00", 2020 "timeZone": "Europe/London", 2021 "duration": "PT1H30M", 2022 "locations": { 2023 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2024 "title": "Math lab room 1", 2025 "description": "Math Lab I, Department of Mathematics" 2026 } 2027 }, 2028 "recurrenceRule": { 2029 "frequency": "weekly", 2030 "until": "2018-06-25T09:00:00" 2031 }, 2032 "recurrenceOverrides": { 2033 "2018-01-05T14:00:00": { 2034 "title": "Introduction to Calculus I (optional)" 2035 }, 2036 "2018-04-02T09:00:00": { 2037 "excluded": "true" 2038 }, 2039 "2018-06-25T09:00:00": { 2040 "title": "Calculus I Exam", 2041 "start": "2018-06-25T10:00:00", 2042 "duration": "PT2H", 2043 "locations": { 2044 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2045 "title": "Big Auditorium", 2046 "description": "Big Auditorium, Other Road" 2047 } 2048 } 2049 } 2050 } 2051 } 2053 6.10. Recurring event with participants 2055 This example illustrates scheduled events. A team meeting occurs 2056 every week since January 8, 2018 at 9am Johannesburg time. The event 2057 owner also chairs the event. Participants meet in a virtual meeting 2058 room. An attendee has accepted the invitation, but on March 8, 2018 2059 he is unavailable and declined participation for this occurrence. 2061 { 2062 "...": "", 2063 "title": "FooBar team meeting", 2064 "start": "2018-01-08T09:00:00", 2065 "timeZone": "Africa/Johannesburg", 2066 "duration": "PT1H", 2067 "virtualLocations": { 2068 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2069 "name": "ChatMe meeting room", 2070 "uri": "https://chatme.example.com?id=1234567" 2071 } 2072 }, 2073 "recurrenceRule": { 2074 "frequency": "weekly" 2075 }, 2076 "replyTo": { 2077 "imip": "mailto:6489-4f14-a57f-c1@schedule.example.com" 2078 }, 2079 "participants": { 2080 "dG9tQGZvb2Jhci5leGFtcGxlLmNvbQ": { 2081 "name": "Tom Tool", 2082 "email": "tom@foobar.example.com", 2083 "sendTo": { 2084 "imip": "mailto:6489-4f14-a57f-c1@calendar.example.com" 2085 }, 2086 "participationStatus": "accepted", 2087 "roles": { 2088 "attendee": true 2089 } 2090 }, 2091 "em9lQGZvb2Jhci5leGFtcGxlLmNvbQ": { 2092 "name": "Zoe Zelda", 2093 "email": "zoe@foobar.example.com", 2094 "sendTo": { 2095 "imip": "mailto:zoe@foobar.example.com" 2096 }, 2097 "participationStatus": "accepted", 2098 "roles": { 2099 "owner": true, 2100 "attendee": true, 2101 "chair": true 2102 } 2103 }, 2104 "...": "" 2105 }, 2106 "recurrenceOverrides": { 2107 "2018-03-08T09:00:00": { 2108 "participants/dG9tQGZvb2Jhci5leGFtcGxlLmNvbQ/participationStatus": 2109 "declined" 2110 } 2111 } 2113 } 2115 7. Security Considerations 2117 The use of JSON as a format does have its own inherent security risks 2118 as discussed in Section 12 of [RFC8259]. Even though JSON is 2119 considered a safe subset of JavaScript, it should be kept in mind 2120 that a flaw in the parser processing JSON could still impose a 2121 threat, which doesn't arise with conventional iCalendar data. 2123 With this in mind, a parser for JSON data aware of the security 2124 implications should be used for the format described in this 2125 document. For example, the use of JavaScript's "eval()" function is 2126 considered an unacceptable security risk, as described in Section 12 2127 of[RFC8259]. A native parser with full awareness of the JSON format 2128 should be preferred. 2130 Several JSCalendar properties contain URIs as values, and processing 2131 these properties requires extra care. Section 7 of [RFC3986] 2132 discusses security risk related to URIs. 2134 8. IANA Considerations 2136 This document defines a MIME media type for use with JSCalendar data 2137 formatted in JSON. 2139 Type name: application 2141 Subtype name: jscalendar+json 2143 Required parameters: type 2145 The "type" parameter conveys the type of the JSCalendar data in 2146 the body part, with the value being one of "jsevent", "jstask", or 2147 "jsgroup". The parameter MUST NOT occur more than once. It MUST 2148 match the value of the "@type" property of the JSON-formatted 2149 JSCalendar object in the body. 2151 Optional parameters: none 2153 Encoding considerations: Same as encoding considerations of 2154 application/json as specified in RFC8529, Section 11 [RFC8259]. 2156 Security considerations: See Section 7 of this document. 2158 Interoperability considerations: This media type provides an 2159 alternative to iCalendar, jCal and proprietary JSON-based 2160 calendaring data formats. 2162 Published specification: This specification. 2164 Applications that use this media type: Applications that currently 2165 make use of the text/calendar and application/calendar+json media 2166 types can use this as an alternative. Similarly, applications 2167 that use the application/json media type to transfer calendaring 2168 data can use this to further specify the content. 2170 Fragment identifier considerations: N/A 2172 Additional information: 2174 Magic number(s): N/A 2176 File extensions(s): N/A 2178 Macintosh file type code(s): N/A 2180 Person & email address to contact for further 2181 information: 2182 calext@ietf.org 2184 Intended usage: COMMON 2186 Restrictions on usage: N/A 2188 Author: See the "Author's Address" section of this document. 2190 Change controller: IETF 2192 9. Acknowledgments 2194 The authors would like to thank the members of CalConnect for their 2195 valuable contributions. This specification originated from the work 2196 of the API technical committee of CalConnect, the Calendaring and 2197 Scheduling Consortium. 2199 10. References 2201 10.1. Normative References 2203 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2204 Requirement Levels", BCP 14, RFC 2119, 2205 DOI 10.17487/RFC2119, March 1997, 2206 . 2208 [RFC2392] Levinson, E., "Content-ID and Message-ID Uniform Resource 2209 Locators", RFC 2392, DOI 10.17487/RFC2392, August 1998, 2210 . 2212 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 2213 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 2214 . 2216 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 2217 Resource Identifier (URI): Generic Syntax", STD 66, 2218 RFC 3986, DOI 10.17487/RFC3986, January 2005, 2219 . 2221 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 2222 Unique IDentifier (UUID) URN Namespace", RFC 4122, 2223 DOI 10.17487/RFC4122, July 2005, 2224 . 2226 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data 2227 Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006, 2228 . 2230 [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault, 2231 "Calendaring Extensions to WebDAV (CalDAV)", RFC 4791, 2232 DOI 10.17487/RFC4791, March 2007, 2233 . 2235 [RFC5545] Desruisseaux, B., Ed., "Internet Calendaring and 2236 Scheduling Core Object Specification (iCalendar)", 2237 RFC 5545, DOI 10.17487/RFC5545, September 2009, 2238 . 2240 [RFC5546] Daboo, C., Ed., "iCalendar Transport-Independent 2241 Interoperability Protocol (iTIP)", RFC 5546, 2242 DOI 10.17487/RFC5546, December 2009, 2243 . 2245 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 2246 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 2247 September 2009, . 2249 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 2250 Identifier for Geographic Locations ('geo' URI)", 2251 RFC 5870, DOI 10.17487/RFC5870, June 2010, 2252 . 2254 [RFC6047] Melnikov, A., Ed., "iCalendar Message-Based 2255 Interoperability Protocol (iMIP)", RFC 6047, 2256 DOI 10.17487/RFC6047, December 2010, 2257 . 2259 [RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type 2260 Specifications and Registration Procedures", BCP 13, 2261 RFC 6838, DOI 10.17487/RFC6838, January 2013, 2262 . 2264 [RFC6901] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., 2265 "JavaScript Object Notation (JSON) Pointer", RFC 6901, 2266 DOI 10.17487/RFC6901, April 2013, 2267 . 2269 [RFC7265] Kewisch, P., Daboo, C., and M. Douglass, "jCal: The JSON 2270 Format for iCalendar", RFC 7265, DOI 10.17487/RFC7265, May 2271 2014, . 2273 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 2274 DOI 10.17487/RFC7493, March 2015, 2275 . 2277 [RFC7529] Daboo, C. and G. Yakushev, "Non-Gregorian Recurrence Rules 2278 in the Internet Calendaring and Scheduling Core Object 2279 Specification (iCalendar)", RFC 7529, 2280 DOI 10.17487/RFC7529, May 2015, 2281 . 2283 [RFC7808] Douglass, M. and C. Daboo, "Time Zone Data Distribution 2284 Service", RFC 7808, DOI 10.17487/RFC7808, March 2016, 2285 . 2287 [RFC7986] Daboo, C., "New Properties for iCalendar", RFC 7986, 2288 DOI 10.17487/RFC7986, October 2016, 2289 . 2291 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 2292 Interchange Format", STD 90, RFC 8259, 2293 DOI 10.17487/RFC8259, December 2017, 2294 . 2296 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 2297 DOI 10.17487/RFC8288, October 2017, 2298 . 2300 10.2. Informative References 2302 [MIME] "IANA Media Types", . 2305 10.3. URIs 2307 [1] https://www.iana.org/time-zones 2309 [2] https://www.iana.org/assignments/link-relations/link- 2310 relations.xhtml 2312 [3] https://www.w3.org/TR/2011/REC-css3-color-20110607/#svg-color 2314 Authors' Addresses 2316 Neil Jenkins 2317 FastMail 2318 PO Box 234 2319 Collins St West 2320 Melbourne VIC 8007 2321 Australia 2323 Email: neilj@fastmailteam.com 2324 URI: https://www.fastmail.com 2326 Robert Stepanek 2327 FastMail 2328 PO Box 234 2329 Collins St West 2330 Melbourne VIC 8007 2331 Australia 2333 Email: rsto@fastmailteam.com 2334 URI: https://www.fastmail.com