idnits 2.17.1 draft-ietf-calext-jscalendar-09.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (November 5, 2018) is 1992 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 2442 -- Looks like a reference, but probably isn't: '2' on line 2445 -- Looks like a reference, but probably isn't: '3' on line 2447 Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Calendaring extensions N. Jenkins 3 Internet-Draft R. Stepanek 4 Intended status: Standards Track FastMail 5 Expires: May 9, 2019 November 5, 2018 7 JSCalendar: A JSON representation of calendar data 8 draft-ietf-calext-jscalendar-09 10 Abstract 12 This specification defines a data model and JSON representation of 13 calendar data that can be used for storage and data exchange in a 14 calendaring and scheduling environment. It aims to be an alternative 15 to the widely deployed iCalendar data format and to be unambiguous, 16 extendable and simple to process. 18 Status of This Memo 20 This Internet-Draft is submitted in full conformance with the 21 provisions of BCP 78 and BCP 79. 23 Internet-Drafts are working documents of the Internet Engineering 24 Task Force (IETF). Note that other groups may also distribute 25 working documents as Internet-Drafts. The list of current Internet- 26 Drafts is at https://datatracker.ietf.org/drafts/current/. 28 Internet-Drafts are draft documents valid for a maximum of six months 29 and may be updated, replaced, or obsoleted by other documents at any 30 time. It is inappropriate to use Internet-Drafts as reference 31 material or to cite them other than as "work in progress." 33 This Internet-Draft will expire on May 9, 2019. 35 Copyright Notice 37 Copyright (c) 2018 IETF Trust and the persons identified as the 38 document authors. All rights reserved. 40 This document is subject to BCP 78 and the IETF Trust's Legal 41 Provisions Relating to IETF Documents 42 (https://trustee.ietf.org/license-info) in effect on the date of 43 publication of this document. Please review these documents 44 carefully, as they describe your rights and restrictions with respect 45 to this document. Code Components extracted from this document must 46 include Simplified BSD License text as described in Section 4.e of 47 the Trust Legal Provisions and are provided without warranty as 48 described in the Simplified BSD License. 50 Table of Contents 52 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 53 1.1. Relation to the iCalendar format . . . . . . . . . . . . 4 54 1.2. Notational Conventions . . . . . . . . . . . . . . . . . 5 55 2. JSCalendar objects . . . . . . . . . . . . . . . . . . . . . 5 56 2.1. JSEvent . . . . . . . . . . . . . . . . . . . . . . . . . 5 57 2.2. JSTask . . . . . . . . . . . . . . . . . . . . . . . . . 5 58 2.3. JSGroup . . . . . . . . . . . . . . . . . . . . . . . . . 6 59 3. Structure of JSCalendar objects . . . . . . . . . . . . . . . 6 60 3.1. Type signatures . . . . . . . . . . . . . . . . . . . . . 6 61 3.2. Data Types . . . . . . . . . . . . . . . . . . . . . . . 7 62 3.2.1. UTCDate . . . . . . . . . . . . . . . . . . . . . . . 7 63 3.2.2. LocalDate . . . . . . . . . . . . . . . . . . . . . . 7 64 3.2.3. Duration . . . . . . . . . . . . . . . . . . . . . . 7 65 3.2.4. PatchObject . . . . . . . . . . . . . . . . . . . . . 8 66 3.2.5. Identifiers . . . . . . . . . . . . . . . . . . . . . 8 67 3.2.6. Normalization and equivalence . . . . . . . . . . . . 8 68 3.3. Custom property extensions and values . . . . . . . . . . 9 69 4. Common JSCalendar properties . . . . . . . . . . . . . . . . 9 70 4.1. Metadata properties . . . . . . . . . . . . . . . . . . . 9 71 4.1.1. @type . . . . . . . . . . . . . . . . . . . . . . . . 9 72 4.1.2. uid . . . . . . . . . . . . . . . . . . . . . . . . . 10 73 4.1.3. relatedTo . . . . . . . . . . . . . . . . . . . . . . 10 74 4.1.4. prodId . . . . . . . . . . . . . . . . . . . . . . . 11 75 4.1.5. created . . . . . . . . . . . . . . . . . . . . . . . 11 76 4.1.6. updated . . . . . . . . . . . . . . . . . . . . . . . 12 77 4.1.7. sequence . . . . . . . . . . . . . . . . . . . . . . 12 78 4.1.8. method . . . . . . . . . . . . . . . . . . . . . . . 12 79 4.2. What and where properties . . . . . . . . . . . . . . . . 12 80 4.2.1. title . . . . . . . . . . . . . . . . . . . . . . . . 12 81 4.2.2. description . . . . . . . . . . . . . . . . . . . . . 12 82 4.2.3. descriptionContentType . . . . . . . . . . . . . . . 12 83 4.2.4. locations . . . . . . . . . . . . . . . . . . . . . . 13 84 4.2.5. virtualLocations . . . . . . . . . . . . . . . . . . 14 85 4.2.6. links . . . . . . . . . . . . . . . . . . . . . . . . 14 86 4.2.7. locale . . . . . . . . . . . . . . . . . . . . . . . 15 87 4.2.8. keywords . . . . . . . . . . . . . . . . . . . . . . 16 88 4.2.9. categories . . . . . . . . . . . . . . . . . . . . . 16 89 4.2.10. color . . . . . . . . . . . . . . . . . . . . . . . . 16 90 4.3. Recurrence properties . . . . . . . . . . . . . . . . . . 16 91 4.3.1. recurrenceRule . . . . . . . . . . . . . . . . . . . 16 92 4.3.2. recurrenceOverrides . . . . . . . . . . . . . . . . . 21 93 4.3.3. excluded . . . . . . . . . . . . . . . . . . . . . . 22 94 4.4. Sharing and scheduling properties . . . . . . . . . . . . 22 95 4.4.1. priority . . . . . . . . . . . . . . . . . . . . . . 22 96 4.4.2. freeBusyStatus . . . . . . . . . . . . . . . . . . . 22 97 4.4.3. privacy . . . . . . . . . . . . . . . . . . . . . . . 23 98 4.4.4. replyTo . . . . . . . . . . . . . . . . . . . . . . . 24 99 4.4.5. participants . . . . . . . . . . . . . . . . . . . . 24 100 4.5. Alerts properties . . . . . . . . . . . . . . . . . . . . 28 101 4.5.1. useDefaultAlerts . . . . . . . . . . . . . . . . . . 28 102 4.5.2. alerts . . . . . . . . . . . . . . . . . . . . . . . 28 103 4.6. Multilingual properties . . . . . . . . . . . . . . . . . 29 104 4.6.1. localizations . . . . . . . . . . . . . . . . . . . . 29 105 5. Type-specific JSCalendar properties . . . . . . . . . . . . . 30 106 5.1. JSEvent properties . . . . . . . . . . . . . . . . . . . 30 107 5.1.1. start . . . . . . . . . . . . . . . . . . . . . . . . 31 108 5.1.2. timeZone . . . . . . . . . . . . . . . . . . . . . . 31 109 5.1.3. duration . . . . . . . . . . . . . . . . . . . . . . 31 110 5.1.4. isAllDay . . . . . . . . . . . . . . . . . . . . . . 31 111 5.1.5. status . . . . . . . . . . . . . . . . . . . . . . . 32 112 5.2. JSTask properties . . . . . . . . . . . . . . . . . . . . 32 113 5.2.1. due . . . . . . . . . . . . . . . . . . . . . . . . . 32 114 5.2.2. start . . . . . . . . . . . . . . . . . . . . . . . . 32 115 5.2.3. timeZone . . . . . . . . . . . . . . . . . . . . . . 32 116 5.2.4. estimatedDuration . . . . . . . . . . . . . . . . . . 33 117 5.2.5. statusUpdatedAt . . . . . . . . . . . . . . . . . . . 33 118 5.2.6. isAllDay . . . . . . . . . . . . . . . . . . . . . . 33 119 5.2.7. progress . . . . . . . . . . . . . . . . . . . . . . 33 120 5.2.8. status . . . . . . . . . . . . . . . . . . . . . . . 34 121 5.3. JSGroup properties . . . . . . . . . . . . . . . . . . . 35 122 5.3.1. entries . . . . . . . . . . . . . . . . . . . . . . . 35 123 5.3.2. source . . . . . . . . . . . . . . . . . . . . . . . 35 124 6. Conversion from and to iCalendar . . . . . . . . . . . . . . 35 125 6.1. JSEvent . . . . . . . . . . . . . . . . . . . . . . . . . 36 126 6.2. JSTask . . . . . . . . . . . . . . . . . . . . . . . . . 36 127 6.3. JSGroup . . . . . . . . . . . . . . . . . . . . . . . . . 38 128 6.4. Common properties . . . . . . . . . . . . . . . . . . . . 38 129 6.5. Locations and participants . . . . . . . . . . . . . . . 40 130 6.6. Unknown properties . . . . . . . . . . . . . . . . . . . 43 131 7. JSCalendar object examples . . . . . . . . . . . . . . . . . 43 132 7.1. Simple event . . . . . . . . . . . . . . . . . . . . . . 43 133 7.2. Simple task . . . . . . . . . . . . . . . . . . . . . . . 44 134 7.3. Simple group . . . . . . . . . . . . . . . . . . . . . . 44 135 7.4. All-day event . . . . . . . . . . . . . . . . . . . . . . 44 136 7.5. Task with a due date . . . . . . . . . . . . . . . . . . 45 137 7.6. Event with end time zone . . . . . . . . . . . . . . . . 45 138 7.7. Floating-time event (with recurrence) . . . . . . . . . . 46 139 7.8. Event with multiple locations and localization . . . . . 46 140 7.9. Recurring event with overrides . . . . . . . . . . . . . 47 141 7.10. Recurring event with participants . . . . . . . . . . . . 48 142 8. Security Considerations . . . . . . . . . . . . . . . . . . . 50 143 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 50 144 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 50 145 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 50 146 11.1. Normative References . . . . . . . . . . . . . . . . . . 50 147 11.2. Informative References . . . . . . . . . . . . . . . . . 52 148 11.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 53 149 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 53 151 1. Introduction 153 This document defines a data model for calendar event and task 154 objects, or groups of such objects, in electronic calendar 155 applications and systems. It aims to be unambiguous, extendable and 156 simple to process. 158 The key design considerations for this data model are as follows: 160 o The attributes of the calendar entry represented must be described 161 as a simple key-value pair, reducing complexity of its 162 representation. 164 o The data model should avoid all ambiguities and make it difficult 165 to make mistakes during implementation. 167 o Most of the initial set of attributes should be taken from the 168 iCalendar data format ([RFC5545], also see Section 1.1), but the 169 specification should add new attributes or value types, or not 170 support existing ones, where appropriate. Conversion between the 171 data formats need not fully preserve semantic meaning. 173 o Extensions, such as new properties and components, MUST NOT lead 174 to requiring an update to this document. 176 The representation of this data model is defined in the I-JSON format 177 [RFC7493], which is a strict subset of the JavaScript Object Notation 178 (JSON) Data Interchange Format [RFC8259]. Using JSON is mostly a 179 pragmatic choice: its widespread use makes JSCalendar easier to 180 adopt, and the ready availability of production-ready JSON 181 implementations eliminates a whole category of parser-related 182 interoperability issues. 184 1.1. Relation to the iCalendar format 186 The iCalendar data format [RFC5545], a widely deployed interchange 187 format for calendaring and scheduling data, has served calendaring 188 vendors for a long while, but contains some ambiguities and pitfalls 189 that can not be overcome without backward-incompatible changes. 191 For example, iCalendar defines various formats for local times, UTC 192 time and dates, which confuses new users. Other sources for errors 193 are the requirement for custom time zone definitions within a single 194 calendar component, as well as the iCalendar format itself; the 195 latter causing interoperability issues due to misuse of CR LF 196 terminated strings, line continuations and subtle differences between 197 iCalendar parsers. Lastly, up until recently the iCalendar format 198 did not have a way to express a concise difference between two 199 calendar components, which results in verbose exchanges during 200 scheduling. 202 Some of these issues were addressed by the jCal [RFC7265] format, 203 which is a direct mapping between iCalendar and JSON. However, it 204 did not attempt to extend or update iCalendar semantics. 206 1.2. Notational Conventions 208 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 209 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 210 document are to be interpreted as described in [RFC2119]. 212 The underlying format used for this specification is JSON. 213 Consequently, the terms "object" and "array" as well as the four 214 primitive types (strings, numbers, booleans, and null) are to be 215 interpreted as described in Section 1 of [RFC8259]. 217 Some examples in this document contain "partial" JSON documents used 218 for illustrative purposes. In these examples, three periods "..." 219 are used to indicate a portion of the document that has been removed 220 for compactness. 222 2. JSCalendar objects 224 This section describes the calendar object types specified by 225 JSCalendar. 227 2.1. JSEvent 229 MIME type: "application/calendar+json;type=jsevent" 231 A JSEvent represents a scheduled amount of time on a calendar, 232 typically a meeting, appointment, reminder or anniversary. Multiple 233 participants may partake in the event at multiple locations. 235 The @type (Section 4.1.1) property value MUST be "jsevent". 237 2.2. JSTask 239 MIME type: "application/calendar+json;type=jstask" 241 A JSTask represents an action-item, assignment, to-do or work item . 243 The @type (Section 4.1.1) property value MUST be "jstask". 245 A JSTask may start and be due at certain points in time, may take 246 some estimated time to complete and may recur; none of which is 247 required. This notably differs from JSEvent (Section 2.1) which is 248 required to start at a certain point in time and typically takes some 249 non-zero duration to complete. 251 2.3. JSGroup 253 MIME type: "application/calendar+json;type=jsgroup" 255 A JSGroup is a collection of JSEvent (Section 2.1) and JSTask 256 (Section 2.2) objects. Typically, objects are grouped by topic (e.g. 257 by keywords) or calendar membership. 259 The @type (Section 4.1.1) property value MUST be "jsgroup". 261 3. Structure of JSCalendar objects 263 A JSCalendar object is a JSON object, which MUST be valid I-JSON (a 264 stricter subset of JSON), as specified in [RFC8259]. Property names 265 and values are case-sensitive. 267 The object has a collection of properties, as specified in the 268 following sections. Unless otherwise specified, all properties are 269 mandatory. Optional properties may have a default value, if 270 explicitly specified in the property definition. 272 3.1. Type signatures 274 Types signatures are given for all JSON objects in this document. 275 The following conventions are used: 277 o "Boolean|String": The value is either a JSON "Boolean" value, or a 278 JSON "String" value. 280 o "Foo": Any name that is not a native JSON type means an object for 281 which the properties (and their types) are defined elsewhere 282 within this document. 284 o "Foo[]": An array of objects of type "Foo". 286 o "String[Foo]": A JSON "Object" being used as a map (associative 287 array), where all the values are of type "Foo". 289 3.2. Data Types 291 In addition to the standard JSON data types, the following data types 292 are used in this specification: 294 3.2.1. UTCDate 296 This is a string in [RFC3339] "date-time" format, with the further 297 restrictions that any letters MUST be in upper-case, the time 298 component MUST be included and the time MUST be in UTC. Fractional 299 second values MUST NOT be included unless non-zero and MUST NOT have 300 trailing zeros, to ensure there is only a single representation for 301 each date-time. 303 For example "2010-10-10T10:10:10.003Z" is OK, but 304 "2010-10-10T10:10:10.000Z" is invalid and MUST be encoded as 305 "2010-10-10T10:10:10Z". 307 In common notation, it should be of the form "YYYY-MM-DDTHH:MM:SSZ". 309 3.2.2. LocalDate 311 This is a date-time string _with no time zone/offset information_. 312 It is otherwise in the same format as UTCDate: "YYYY-MM-DDTHH:MM:SS". 313 The time zone to associate the LocalDate with comes from an 314 associated property, or if no time zone is associated it defines 315 _floating time_. Floating date-times are not tied to any specific 316 time zone. Instead, they occur in every timezone at the same _wall- 317 clock_ time (as opposed to the same instant point in time). 319 3.2.3. Duration 321 A duration is represented by a subset of ISO8601 duration format, as 322 specified by the following ABNF: 324 dur-secfrac = "." 1*DIGIT 325 dur-second = 1*DIGIT [dur-secfrac] "S" 326 dur-minute = 1*DIGIT "M" [dur-second] 327 dur-hour = 1*DIGIT "H" [dur-minute] 328 dur-time = "T" (dur-hour / dur-minute / dur-second) 329 dur-day = 1*DIGIT "D" 330 dur-week = 1*DIGIT "W" 332 duration = "P" (dur-day [dur-time] / dur-time / dur-week) 334 In addition, the duration MUST NOT include fractional second values 335 unless the fraction is non-zero. 337 3.2.4. PatchObject 339 A *PatchObject* is of type "String[*|null]", and represents an 340 unordered set of patches on a JSON object. The keys are a path in a 341 subset of [RFC6901] JSON pointer format, with an implicit leading "/" 342 (i.e. prefix each key with "/" before applying the JSON pointer 343 evaluation algorithm). 345 A patch within a PatchObject is only valid, if all of the following 346 conditions apply: 348 1. The pointer MUST NOT reference inside an array (i.e. it MUST NOT 349 insert/delete from an array; the array MUST be replaced in its 350 entirety instead). 352 2. When evaluating a path, all parts prior to the last (i.e. the 353 value after the final slash) MUST exist. 355 3. There MUST NOT be two patches in the PatchObject where the 356 pointer of one is the prefix of the pointer of the other, e.g. 357 "alerts/foo/offset" and "alerts". 359 The value associated with each pointer is either: 361 o "null": Remove the property from the patched object. If not 362 present in the parent, this a no-op. 364 o Anything else: The value to replace the inherited property on the 365 patch object with (if present) or add to the property (if not 366 present). 368 Implementations MUST reject a PatchObject if any of its patches are 369 invalid. 371 3.2.5. Identifiers 373 If not noted otherwise, properties and object keys that define 374 identifiers MUST be string values, MUST be at least 1 character in 375 length and maximum 256 octets in size, and MUST only contain 376 characters from the "URL and Filename safe" Base 64 Alphabet, as 377 defined in section 5 of [RFC4648]. This is the ASCII alphanumeric 378 characters (A-Za-z0-9), hyphen (-), and underscore (_). 380 3.2.6. Normalization and equivalence 382 JSCalendar aims to provide unambiguous definitions for value types 383 and properties, but does not define a general normalization or 384 equivalence method for JSCalendar objects and types. This is because 385 the notion of equivalence might range from byte-level equivalence to 386 semantic equivalence, depending on the respective use case (for 387 example, the CalDAV protocol [RFC4791] requires octet equivalence of 388 the encoded calendar object to determine ETag equivalence). 390 Normalization of JSCalendar objects is hindered because of the 391 following reasons: 393 o Custom JSCalendar properties may contain arbitrary JSON values, 394 including arrays. However, equivalence of arrays might or might 395 not depend on the order of elements, depending on the respective 396 property definition. 398 o Several JSCalendar property values are defined as URIs and MIME 399 types, but normalization of these types is inherently protocol and 400 scheme-specific, depending on the use-case of the equivalence 401 definition (see section 6 of [RFC3986]). 403 Considering this, the definition of equivalence and normalization is 404 left to client and server implementations and to be negotiated by a 405 calendar exchange protocol or defined by another RFC. 407 3.3. Custom property extensions and values 409 Vendors MAY add additional properties to the calendar object to 410 support their custom features. The names of these properties MUST be 411 prefixed with a domain name controlled by the vendor to avoid 412 conflict, e.g. "example.com/customprop". 414 Some JSCalendar properties allow vendor-specific value extensions. 415 If so, vendor specific values MUST be prefixed with a domain name 416 controlled by the vendor, e.g. "example.com/customrel", unless 417 otherwise noted. 419 4. Common JSCalendar properties 421 This section describes the properties that are common to the various 422 JSCalendar object types. Specific JSCalendar object types may only 423 support a subset of these properties. The object type definitions in 424 Section 5 describe the set of supported properties per type. 426 4.1. Metadata properties 428 4.1.1. @type 430 Type: "String" 431 Specifies the type which this object represents. This MUST be one of 432 the following values, registered in a future RFC, or a vendor- 433 specific value: 435 o "jsevent": a JSCalendar event (Section 2.1). 437 o "jstask": a JSCalendar task (Section 2.2). 439 o "jsgroup": a JSCalendar group (Section 2.3). 441 A valid JSCalendar object MUST include this property. 443 4.1.2. uid 445 Type: "String" 447 A globally unique identifier, used to associate the object as the 448 same across different systems, calendars and views. The value of 449 this property MUST be unique across _all_ JSCalendar objects, even if 450 they are of different type. [RFC4122] describes a range of 451 established algorithms to generate universally unique identifiers 452 (UUID), and the random or pseudo-random version is recommended. 454 For compatibility with [RFC5545] UIDs, implementations MUST be able 455 to receive and persist values of at least 255 octets for this 456 property, but they MUST NOT truncate values in the middle of a UTF-8 457 multi-octet sequence. 459 A valid JSCalendar object MUST include this property. 461 4.1.3. relatedTo 463 Type: "String[Relation]" (optional) 465 Relates the object to other JSCalendar objects. This is represented 466 as a map of the UIDs of the related objects to information about the 467 relation. 469 A *Relation* object has the following properties: 471 o *relation*: "String[Boolean]" (optional) Describes how the linked 472 object is related to this object as a set of relation types. If 473 not null, the set MUST NOT be empty. 475 Keys in the set MUST be one of the following values, defined in a 476 future specification or a vendor-specific value: 478 * "first": The linked object is the first in the series this 479 object is part of. 481 * "next": The linked object is the next in the series this object 482 is part of. 484 * "child": The linked object is a subpart of this object. 486 * "parent": This object is part of the overall linked object. 488 The value for each key in the set MUST be "true". 490 If an object is split to make a "this and future" change to a 491 recurrence, the original object MUST be truncated to end at the 492 previous occurrence before this split, and a new object created to 493 represent all the objects after the split. A "next" relation MUST be 494 set on the original object's relatedTo property for the UID of the 495 new object. A "first" relation for the UID of the first object in 496 the series MUST be set on the new object. Clients can then follow 497 these UIDs to get the complete set of objects if the user wishes to 498 modify them all at once. 500 4.1.4. prodId 502 Type: "String" (optional) 504 The identifier for the product that created the JSCalendar object. 506 The vendor of the implementation SHOULD ensure that this is a 507 globally unique identifier, using some technique such as an FPI 508 value, as defined in [ISO.9070.1991]. It MUST only use characters of 509 an iCalendar TEXT data value (see section 3.3.11 in [RFC5545]). 511 This property SHOULD NOT be used to alter the interpretation of an 512 JSCalendar object beyond the semantics specified in this document. 513 For example, it is not to be used to further the understanding of 514 non-standard properties. 516 4.1.5. created 518 Type: "UTCDate" (optional) 520 The date and time this object was initially created. 522 4.1.6. updated 524 Type: "UTCDate" 526 The date and time the data in this object was last modified. 528 4.1.7. sequence 530 Type: "Number" (optional, default:"0") 532 Initially zero, this MUST be a non-negative integer that is 533 monotonically incremented each time a change is made to the object. 535 4.1.8. method 537 Type: "String" (optional) 539 The iTIP ([RFC5546]) method, in lower-case. Used for scheduling. 541 4.2. What and where properties 543 4.2.1. title 545 Type: "String" (optional, default:"") 547 A short summary of the object. 549 4.2.2. description 551 Type: "String" (optional, default:"") 553 A longer-form text description of the object. The content is 554 formatted according to the *descriptionContentType* property. 556 4.2.3. descriptionContentType 558 Type: "String" (optional, default:"text/plain") 560 Describes the media type ([RFC6838]) of the contents of the 561 "description" property. Media types MUST be sub-types of type 562 "text", and SHOULD be "text/plain" or "text/html" ([MIME]). They MAY 563 define parameters and the "charset" parameter MUST be "utf-8", if 564 specified. Descriptions of type "text/html" MAY contain "cid" URLs 565 ([RFC2392]) to reference links in the calendar object by use of the 566 *cid* property of the *Link* object. 568 4.2.4. locations 570 Type: "String[Location]" (optional) 572 A map of location ids to Location objects, representing locations 573 associated with the object. A location id MUST be unique to this 574 object; a UUID is a practical choice. 576 A *Location* object has the following properties. It must define at 577 least one other property than *rel*. 579 o *name*: "String" (optional, default:"") The human-readable name of 580 the location. 582 o *description*: "String" (optional) Human-readable, plain-text 583 instructions for accessing this location. This may be an address, 584 set of directions, door access code, etc. 586 o *rel*: "String" (optional) The relation type of this location to 587 the JSCalendar object. 589 This MUST be either one of the following values, registered in a 590 future RFC, or a vendor-specific value. Any value the client or 591 server doesn't understand should be treated the same as if this 592 property is omitted. 594 * "start": The JSCalendar object starts at this location. 596 * "end": The JSCalendar object ends at this location. 598 o *timeZone*: "String" (optional) A time zone for this location. 600 o *coordinates*: "String" (optional) An [RFC5870] "geo:" URI for the 601 location. 603 o *linkIds*: "String[Boolean]" (optional) A set of link ids for 604 links to alternate representations of this location. Each key in 605 the set MUST be the identifier of a Link object defined in the 606 *links* property of this calendar object. The value for each key 607 in the set MUST be "true". This MUST be omitted if none (rather 608 than an empty set). 610 For example, an alternative representation could be in vCard 611 format. 613 4.2.5. virtualLocations 615 Type: "String[VirtualLocation]" (optional) 617 A map of ids to VirtualLocation objects, representing virtual 618 locations, such as video conferences or chat rooms, associated with 619 the object. A virtual location id MUST be unique to this object; a 620 UUID is a practical choice. 622 A *VirtualLocation* object has the following properties. 624 o *name*: "String" (optional, default:"") The human-readable name of 625 the virtual 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 *uri*: "String" A URI that represents how to connect to this 632 virtual location. 634 This may be a telephone number (represented as 635 "tel:+1-555-555-555") for a teleconference, a web address for 636 online chat, or any custom URI. 638 4.2.6. links 640 Type: "String[Link]" (optional) 642 A map of link ids to Link objects, representing external resources 643 associated with the object. A link id MUST be unique to this 644 calendar object; a UUID is a practical choice. 646 A *Link* object has the following properties: 648 o *href*: "String" A URI from which the resource may be fetched. 650 This MAY be a "data:" URL, but it is recommended that the file be 651 hosted on a server to avoid embedding arbitrarily large data in 652 JSCalendar object instances. 654 o *cid* "String" (optional) This MUST be a valid "content-id" value 655 according to the definition of section 2 in [RFC2392]. The 656 identifier MUST be unique within this JSCalendar object but has no 657 meaning beyond that. Specifically, it MAY be different from the 658 link identifier in the enclosing *links* property. 660 o *type*: "String" (optional) The content-type [RFC6838] of the 661 resource, if known. 663 o *size*: "Number" (optional) The size, in bytes, of the resource 664 when fully decoded (i.e. the number of bytes in the file the user 665 would download), if known. 667 o *rel*: "String" (optional) Identifies the relation of the linked 668 resource to the object. If set, the value MUST be a registered 669 relation type (see [RFC8288] and IANA Link Relations [1]). 671 Links with a rel of "enclosure" SHOULD be considered by the client 672 as attachments for download. 674 Links with a rel of "describedby" SHOULD be considered by the 675 client to be an alternate representation of the description. 677 Links with a rel of "icon" SHOULD be considered by the client to 678 be an image that it MAY use when presenting the calendar data to a 679 user. The *display* property MAY be set to indicate the purpose 680 of this image. 682 o *display*: "String" (optional) Describes the intended purpose of a 683 link to an image. If set, the *rel* property MUST be set to 684 "icon". The value MUST be either one of the following values, 685 registered in a future RFC, or a vendor-specific value: 687 * "badge": an image inline with the title of the object 689 * "graphic": a full image replacement for the object itself 691 * "fullsize": an image that is used to enhance the object 693 * "thumbnail": a smaller variant of "fullsize " to be used when 694 space for the image is constrained 696 o *title*: "String" (optional) A human-readable plain-text 697 description of the resource. 699 4.2.7. locale 701 Type: "String" (optional) 703 The [RFC5646] language tag that best describes the locale used for 704 the calendar object, if known. 706 4.2.8. keywords 708 Type: "String[Boolean]" (optional) 710 A set of keywords or tags that relate to the object. The set is 711 represented as a map, with the keys being the keywords. The value 712 for each key in the map MUST be "true". 714 4.2.9. categories 716 Type: "String[Boolean]" (optional) 718 A set of categories that relate to the calendar object. The set is 719 represented as a map, with the keys being the categories specified as 720 URIs. The value for each key in the map MUST be "true". 722 In contrast to *keywords*, categories typically are structured. For 723 example, a vendor owning the domain "example.com" might define the 724 categories "http://example.com/categories/sports/american-football"" 725 and "http://example.com/categories/music/r-b". 727 4.2.10. color 729 Type: "String" (optional) 731 Specifies a color clients MAY use when displaying this calendar 732 object. The value is a case-insensitive color name taken from the 733 CSS3 set of names, defined in Section 4.3 of W3C.REC- 734 css3-color-20110607 [2] or a CSS3 RGB color hex value. 736 4.3. Recurrence properties 738 4.3.1. recurrenceRule 740 Type: "Recurrence" 742 Defines a recurrence rule (repeating pattern) for recurring calendar 743 objects. 745 A *Recurrence* object is a JSON object mapping of a RECUR value type 746 in iCalendar, see [RFC5545] and[RFC7529]. A JSEvent recurs by 747 applying the recurrence rule (and *recurrenceOverrides*) to the 748 *start* date/time. A JSTask recurs by applying the recurrence rule 749 (and *recurrenceOverrides*) to its *start* date/time, if defined. If 750 the task does not define a start date-time, it recurs by its *due* 751 date-time. If it neither defines a start or due date-time, it MUST 752 NOT define a *recurrenceRule*. 754 A Recurrence object has the following properties: 756 o *frequency*: "String" This MUST be one of the following values: 758 * "yearly" 760 * "monthly" 762 * "weekly" 764 * "daily" 766 * "hourly" 768 * "minutely" 770 * "secondly" 772 To convert from iCalendar, simply lower-case the FREQ part. 774 o *interval*: "Number" (optional, default:"1") The INTERVAL part 775 from iCal. If included, it MUST be an integer "x >= 1". 777 o *rscale*: "String" (optional, default:""gregorian"") The RSCALE 778 part from iCalendar RSCALE [RFC7529], converted to lower-case. 780 o *skip*: "String" (optional, default:""omit"") The SKIP part from 781 iCalendar RSCALE [RFC7529], converted to lower-case. 783 o *firstDayOfWeek*: "String" (optional, default:""mo"") The WKST 784 part from iCalendar, represented as a lower-case abbreviated two- 785 letter English day of the week. If included, it MUST be one of 786 the following values: ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 788 o *byDay*: "NDay[]" (optional) An *NDay* object has the following 789 properties: 791 * *day*: "String" The day-of-the-week part of the BYDAY value in 792 iCalendar, lower-cased. MUST be one of the following values: 793 ""mo"|"tu"|"we"|"th"|"fr"|"sa"|"su"". 795 * *nthOfPeriod*: "Number" (optional) The ordinal part of the 796 BYDAY value in iCalendar (e.g. ""+1"" or ""-3""). If present, 797 rather than representing every occurrence of the weekday 798 defined in the *day* property of this *NDay*, it represents 799 only a specific instance within the recurrence period. The 800 value can be positive or negative, but MUST NOT be zero. A 801 negative integer means nth-last of period. 803 o *byMonthDay*: "Number[]" (optional) The BYMONTHDAY part from 804 iCalendar. The array MUST have at least one entry if included. 806 o *byMonth*: "String[]" (optional) The BYMONTH part from iCalendar. 807 Each entry is a string representation of a number, starting from 808 "1" for the first month in the calendar (e.g. ""1" " means 809 ""January"" with Gregorian calendar), with an optional ""L"" 810 suffix (see [RFC7529]) for leap months (this MUST be upper-case, 811 e.g. ""3L""). The array MUST have at least one entry if included. 813 o *byYearDay*: "Number[]" (optional) The BYYEARDAY part from 814 iCalendar. The array MUST have at least one entry if included. 816 o *byWeekNo*: "Number[]" (optional) The BYWEEKNO part from 817 iCalendar. The array MUST have at least one entry if included. 819 o *byHour*: "Number[]" (optional) The BYHOUR part from iCalendar. 820 The array MUST have at least one entry if included. 822 o *byMinute*: "Number[]" (optional) The BYMINUTE part from 823 iCalendar. The array MUST have at least one entry if included. 825 o *bySecond*: "Number[]" (optional) The BYSECOND part from 826 iCalendar. The array MUST have at least one entry if included. 828 o *bySetPosition*: "Number[]" (optional) The BYSETPOS part from 829 iCalendar. The array MUST have at least one entry if included. 831 o *count*: "Number" (optional) The COUNT part from iCalendar. This 832 MUST NOT be included if an *until* property is specified. 834 o *until*: "LocalDate" (optional) The UNTIL part from iCalendar. 835 This MUST NOT be included if a *count* property is specified. 836 Note, as in iCalendar, this date is presumed to be in the time 837 zone specified in *timeZone*. It is not a UTC time. 839 A recurrence rule specifies a set of set of date-times for recurring 840 calendar objects. A recurrence rule has the following semantics: 842 1. A set of candidates is generated. This is every second within a 843 period defined by the frequency property: 845 * *yearly*: every second from midnight on the 1st January 846 (inclusive) to midnight the following 1st January (exclusive) 848 * *monthly*: every second from midnight on the 1st of a month 849 (inclusive) to midnight on the 1st of the following month 850 (exclusive) 852 * *weekly*: every second from midnight (inclusive) on the first 853 day of the week (as defined by the firstDayOfWeek property, or 854 Monday if omitted), to midnight 7 days later (exclusive). 856 * *daily*: every second from midnight at the start of the day 857 (inclusive) to midnight at the end of the day (exclusive). 859 * *hourly*: every second from the beginning of the hour 860 (inclusive) to the beginning of the next hour (exclusive). 862 * *minutely*: every second from the beginning of the minute 863 (inclusive) to the beginning of the next minute (exclusive). 865 * *secondly*: the second itself, only. 867 2. Each date-time candidate is compared against all of the byX 868 properties of the rule except bySetPosition. If any property in 869 the rule does not match the date-time, it is eliminated. Each 870 byX property is an array; the date-time matches the property if 871 it matches any of the values in the array. The properties have 872 the following semantics: 874 * *byMonth*: the date-time is in the given month. 876 * *byMonthDay*: the date-time is on the given day of the month. 877 Negative numbers mean the nth last day of the month. 879 * *byDay*: the date-time is on the given day of the week. If 880 the day is prefixed by a number, it is the nth occurrence of 881 that day of the week within the month (if frequency is 882 monthly) or year (if frequency is yearly). Negative numbers 883 means nth last occurrence within that period. 885 * *byYearDay*: the date-time is on the nth day of year. 886 Negative numbers mean the nth last day of the year. 888 * *byWeekNo*: the date-time is in the nth week of the year. 889 Negative numbers mean the nth last week of the year. This 890 corresponds to weeks according to week numbering as defined in 891 ISO.8601.2004, with a week defined as a seven day period, 892 starting on the firstDayOfWeek property value or Monday if 893 omitted. Week number one of the calendar year is the first 894 week that contains at least four days in that calendar year. 896 * *byHour*: the date-time has the given hour value. 898 * *byMinute*: the date-time has the given minute value. 900 * *bySecond*: the date-time has the given second value. 902 3. If a bySetPosition property is included, this is now applied to 903 the ordered list of remaining dates (this property specifies the 904 indexes of date-times to keep; all others should be eliminated. 905 Negative numbers are indexes from the end of the list, with -1 906 being the last item). 908 4. Any date-times before the start date of the event are eliminated 909 (see below for why this might be needed). 911 5. If further dates are required (we have not reached the until 912 date, or count limit) skip the next (interval - 1) sets of 913 candidates, then continue from step 1. 915 When determining the set of occurrence dates for an event or task, 916 the following extra rules must be applied: 918 1. The start date-time is always the first occurrence in the 919 expansion (and is counted if the recurrence is limited by a 920 "count" property), even if it would normally not match the rule. 922 2. The first set of candidates to consider is that which would 923 contain the start date-time. This means the first set may 924 include candidates before the start; such candidates are 925 eliminated from the results in step (4) as outlined before. 927 3. The following properties MUST be implicitly added to the rule 928 under the given conditions: 930 * If frequency > "secondly" and no bySecond property: Add a 931 bySecond property with the sole value being the seconds value 932 of the start date-time. 934 * If frequency > "minutely" and no byMinute property: Add a 935 byMinute property with the sole value being the minutes value 936 of the start date-time. 938 * If frequency > "hourly" and no byHour property: Add a byHour 939 property with the sole value being the hours value of the 940 start date-time. 942 * If frequency is "weekly" and no byDay property: Add a byDay 943 property with the sole value being the day-of-the-week of the 944 start date-time. 946 * If frequency is "monthly" and no byDay property and no 947 byMonthDay property: Add a byMonthDay property with the sole 948 value being the day-of-the-month of the start date-time. 950 * If frequency is "yearly" and no byYearDay property: 952 + if there are no byMonth or byWeekNo properties, and either 953 there is a byMonthDay property or there is no byDay 954 property: Add a byMonth property with the sole value being 955 the month of the start date-time. 957 + if there is no byMonthDay, byWeekNo or byDay properties: 958 Add a byMonthDay property with the sole value being the 959 day-of-the-month of the start date-time. 961 + if there is a byWeekNo property and no byMonthDay or byDay 962 properties: Add a byDay property with the sole value being 963 the day-of-the-week of the start date-time. 965 4.3.2. recurrenceOverrides 967 Type: "LocalDate[PatchObject]" (optional) 969 A map of the recurrence-ids (the date-time of the start of the 970 occurrence) to an object of patches to apply to the generated 971 occurrence object. 973 If the recurrence-id does not match an expanded start date from a 974 recurrence rule, it is to be treated as an additional occurrence 975 (like an RDATE from iCalendar). The patch object may often be empty 976 in this case. 978 If the patch object defines the *excluded* property to be "true", 979 then the recurring calendar object does not occur at the recurrence- 980 id date-time (like an EXDATE from iCalendar). Such a patch object 981 MUST NOT patch any other property. 983 By default, an occurrence inherits all properties from the main 984 object except the start (or due) date-time, which is shifted to the 985 new start time of the LocalDate key. However, individual properties 986 of the occurrence can be modified by a patch, or multiple patches. 987 It is valid to patch the start property value, and this patch takes 988 precedence over the LocalDate key. Both the LocalDate key as well as 989 the patched start date-time may occur before the original JSCalendar 990 object's start or due date. 992 A pointer in the PatchObject MUST NOT start with one of the following 993 prefixes; any patch with such a key MUST be ignored: 995 o @type 997 o uid 999 o relatedTo 1001 o prodId 1003 o method 1005 o isAllDay 1007 o recurrenceRule 1009 o recurrenceOverrides 1011 o replyTo 1013 4.3.3. excluded 1015 Type: "Boolean" (optional, default:"false") 1017 Defines if this object is an overridden, excluded instance of a 1018 recurring JSCalendar object (also see Section 4.3.2). If this 1019 property value is "true", this calendar object instance MUST be 1020 removed from the occurrence expansion. 1022 4.4. Sharing and scheduling properties 1024 4.4.1. priority 1026 Type: "Number" (optional, default:"0") 1028 Specifies a priority for the calendar object. This may be used as 1029 part of scheduling systems to help resolve conflicts for a time 1030 period. 1032 The priority is specified as an integer in the range 0 to 9. A value 1033 of 0 specifies an undefined priority. A value of 1 is the highest 1034 priority. A value of 2 is the second highest priority. Subsequent 1035 numbers specify a decreasing ordinal priority. A value of 9 is the 1036 lowest priority. Other integer values are reserved for future use. 1038 4.4.2. freeBusyStatus 1040 Type: "String" (optional, default:"busy") 1041 Specifies how this property should be treated when calculating free- 1042 busy state. The value MUST be one of: 1044 o ""free"": The object should be ignored when calculating whether 1045 the user is busy. 1047 o ""busy"": The object should be included when calculating whether 1048 the user is busy. 1050 4.4.3. privacy 1052 Type: "String" (optional, default:"public") 1054 Calendar objects are normally collected together and may be shared 1055 with other users. The privacy property allows the object owner to 1056 indicate that it should not be shared, or should only have the time 1057 information shared but the details withheld. Enforcement of the 1058 restrictions indicated by this property are up to the 1059 implementations. 1061 This property MUST NOT affect the information sent to scheduled 1062 participants; it is only interpreted when the object is shared as 1063 part of a shared calendar. 1065 The value MUST be either one of the following values, registered in a 1066 future RFC, or a vendor-specific value. Vendor specific values MUST 1067 be prefixed with a domain name controlled by the vendor, e.g. 1068 "example.com/topsecret". Any value the client or server doesn't 1069 understand should be preserved but treated as equivalent to 1070 "private". 1072 o "public": The full details of the object are visible to those whom 1073 the object's calendar is shared with. 1075 o "private": The details of the object are hidden; only the basic 1076 time and metadata is shared. Implementations MUST ensure the 1077 following properties are stripped when the object is accessed by a 1078 sharee: 1080 * title 1082 * description 1084 * locations 1086 * links 1088 * locale 1089 * localizations 1091 * participants 1093 * replyTo 1095 In addition, any patches in "recurrenceOverrides" whose key is 1096 prefixed with one of the above properties MUST be stripped. 1098 o "secret": The object is hidden completely (as though it did not 1099 exist) when the calendar is shared. 1101 4.4.4. replyTo 1103 Type: "String[String]" (optional) 1105 Represents methods by which participants may submit their RSVP 1106 response to the organizer of the calendar object. The keys in the 1107 property value are the available methods and MUST only contain ASCII 1108 alphanumeric characters (A-Za-z0-9). The value is a URI to use that 1109 method. Future methods may be defined in future specifications; a 1110 calendar client MUST ignore any method it does not understand, but 1111 MUST preserve the method key and URI. This property MUST be omitted 1112 if no method is defined (rather than an empty object). 1114 The following methods are defined: 1116 o "imip": The organizer accepts an iMIP [RFC6047] response at this 1117 email address. The value MUST be a "mailto:" URI. 1119 o "web": Opening this URI in a web browser will provide the user 1120 with a page where they can submit a reply to the organizer. 1122 o "other": The organizer is identified by this URI but the method 1123 how to submit the RSVP is undefined. 1125 4.4.5. participants 1127 Type: "String[Participant]" (optional) 1129 A map of participant ids to participants, describing their 1130 participation in the calendar object. A participant id MUST be 1131 unique to this calendar object; a UUID or the base-64 encoded email 1132 address of the participant is a good choice. 1134 A *Participant* object has the following properties: 1136 o *name*: "String" (optional) The display name of the participant 1137 (e.g. "Joe Bloggs"). 1139 o *email*: "String" (optional) The email address for the 1140 participant. 1142 o *sendTo*: "String[String]" Represents methods by which the 1143 participant may receive the invitation and updates to the calendar 1144 object. 1146 The keys in the property value are the available methods and MUST 1147 only contain ASCII alphanumeric characters (A-Za-z0-9). The value 1148 is a URI to use that method. Future methods may be defined in 1149 future specifications; a calendar client MUST ignore any method it 1150 does not understand, but MUST preserve the method key and URI. 1151 This property MUST be omitted if no method is defined (rather than 1152 an empty object). 1154 The following methods are defined: 1156 * "imip": The participant accepts an iMIP [RFC6047] request at 1157 this email address. The value MUST be a "mailto:" URI. It MAY 1158 be different from the value of the participant's *email* 1159 property. 1161 * "other": The participant is identified by this URI but the 1162 method how to submit the invitation or update is undefined. 1164 o *kind*: "String" (optional) What kind of entity this participant 1165 is, if known. 1167 This MUST be either one of the following values, registered in a 1168 future RFC, or a vendor-specific value. Any value the client or 1169 server doesn't understand should be treated the same as if this 1170 property is omitted. 1172 * "individual": a single person 1174 * "group": a collection of people invited as a whole 1176 * "resource": a non-human resource, e.g. a projector 1178 * "location": a physical location involved in the calendar object 1179 that needs to be scheduled, e.g. a conference room. 1181 o *roles*: "String[Boolean]" A set of roles that this participant 1182 fulfills. 1184 At least one role MUST be specified for the participant. The keys 1185 in the set MUST be either one of the following values, registered 1186 in a future RFC, or a vendor-specific value: 1188 * "owner": The participant is an owner of the object. 1190 * "attendee": The participant is an attendee of the calendar 1191 object. 1193 * "chair": The participant is in charge of the calendar object 1194 when it occurs. 1196 The value for each key in the set MUST be "true". Roles that are 1197 unknown to the implementation MUST be preserved and MAY be 1198 ignored. 1200 o *locationId*: "String" (optional) The location at which this 1201 participant is expected to be attending. 1203 If the value does not correspond to any location id in the 1204 *locations* property of the instance, this MUST be treated the 1205 same as if the participant's locationId were omitted. 1207 o *participationStatus*: "String" (optional, default:"needs-action") 1208 The participation status, if any, of this participant. 1210 The value MUST be either one of the following values, registered 1211 in a future RFC, or a vendor-specific value: 1213 * "needs-action": No status yet set by the participant. 1215 * "accepted": The invited participant will participate. 1217 * "declined": The invited participant will not participate. 1219 * "tentative": The invited participant may participate. 1221 o *attendance*: "String" (optional, default:"required") The required 1222 attendance of this participant. 1224 The value MUST be either one of the following values, registered 1225 in a future RFC, or a vendor-specific value. Any value the client 1226 or server doesn't understand should be treated the same as 1227 "required". 1229 * "none": Indicates a participant who is copied for information 1230 purposes only. 1232 * "optional": Indicates a participant whose attendance is 1233 optional. 1235 * "required": Indicates a participant whose attendance is 1236 required. 1238 o *expectReply*: "Boolean" (optional, default:"false") If true, the 1239 organizer is expecting the participant to notify them of their 1240 status. 1242 o *scheduleSequence*: "Number" (optional, default:"0") The sequence 1243 number of the last response from the participant. If defined, 1244 this MUST be a non-negative integer. 1246 This can be used to determine whether the participant has sent a 1247 new RSVP following significant changes to the calendar object, and 1248 to determine if future responses are responding to a current or 1249 older view of the data. 1251 o *scheduleUpdated*: "UTCDate" (optional) The *updated* property of 1252 the last iMIP response from the participant. 1254 This can be compared to the *updated* timestamp in future iMIP 1255 responses to determine if the response is older or newer than the 1256 current data. 1258 o *invitedBy*: "String" (optional) The participant id of the 1259 participant who invited this one, if known. 1261 o *delegatedTo*: "String[Boolean]" (optional) A set of participant 1262 ids that this participant has delegated their participation to. 1263 Each key in the set MUST be the identifier of a participant. The 1264 value for each key in the set MUST be "true". This MUST be 1265 omitted if none (rather than an empty set). 1267 o *delegatedFrom*: "String[Boolean]" (optional) A set of participant 1268 ids that this participant is acting as a delegate for. Each key 1269 in the set MUST be the identifier of a participant. The value for 1270 each key in the set MUST be "true". This MUST be omitted if none 1271 (rather than an empty set). 1273 o *memberOf*: "String[Boolean]" (optional) A set of group 1274 participants that were invited to this calendar object, which 1275 caused this participant to be invited due to their membership of 1276 the group(s). Each key in the set MUST be the identifier of a 1277 participant. The value for each key in the set MUST be "true". 1278 This MUST be omitted if none (rather than an empty set). 1280 o *linkIds*: "String[Boolean]" (optional) A set of links to more 1281 information about this participant, for example in vCard format. 1282 The keys in the set MUST be the identifier of a Link object in the 1283 calendar object's *links* property. The value for each key in the 1284 set MUST be "true". This MUST be omitted if none (rather than an 1285 empty set). 1287 4.5. Alerts properties 1289 4.5.1. useDefaultAlerts 1291 Type: "Boolean" (optional, default:"false") 1293 If "true", use the user's default alerts and ignore the value of the 1294 *alerts* property. Fetching user defaults is dependent on the API 1295 from which this JSCalendar object is being fetched, and is not 1296 defined in this specification. If an implementation cannot determine 1297 the user's default alerts, or none are set, it MUST process the 1298 alerts property as if useDefaultAlerts is set to "false". 1300 4.5.2. alerts 1302 Type: "String[Alert]" (optional) 1304 A map of alert ids to Alert objects, representing alerts/reminders to 1305 display or send the user for this calendar object. The id MUST be 1306 unique to this calendar object; a UUID is a practical choice. 1308 An *Alert* Object has the following properties: 1310 o *relativeTo*: "String" (optional, default:"before-start") 1311 Specifies where the offset is relative to for the alarm to 1312 trigger. The value MUST be one of: 1314 * "before-start" 1316 * "after-start" 1318 * "before-end" 1320 * "after-end" 1322 o *offset*: "Duration" The offset from the start and end/due of the 1323 calendar object to fire the alert. If the calendar object does 1324 not define a time zone, the user's default time zone SHOULD be 1325 used when determining the offset, if known. Otherwise, the time 1326 zone to use is implementation specific. 1328 o *acknowledged*: "UTCDate" (optional) 1330 When the user has permanently dismissed the alert the client MUST 1331 set this to the current time in UTC. Other clients which sync 1332 this property can then automatically dismiss or suppress duplicate 1333 alerts (alerts with the same alert id that triggered on or before 1334 this date-time). 1336 For a recurring calendar object, the *acknowledged* property of 1337 the parent object MUST be updated, unless the alert is already 1338 overridden in *recurrenceOverrides*. 1340 o *snoozed*: "UTCDate" (optional) 1342 If the user temporarily dismisses the alert, this is the UTC date- 1343 time after which it should trigger again. Setting this property 1344 on an instance of a recurring calendar object MUST update the 1345 alarm on the master object, unless the respective instance already 1346 is defined in "recurrenceOverrides". It MUST NOT generate an 1347 override for the sole use of snoozing an alarm. 1349 o *action*: "String" (optional, default:"display") Describes how to 1350 alert the user. 1352 The value MUST be at most one of the following values, registered 1353 in a future RFC, or a vendor-specific value: 1355 * "display": The alert should be displayed as appropriate for the 1356 current device and user context. 1358 * "email": The alert should trigger an email sent out to the 1359 user, notifying about the alert. This action is typically only 1360 appropriate for server implementations. 1362 4.6. Multilingual properties 1364 4.6.1. localizations 1366 Type: "String[PatchObject]" (optional) 1368 A map of [RFC5646] language tags to patch objects, which localize the 1369 calendar object into the locale of the respective language tag. 1371 See the description of PatchObject (Section 3.2.4) for the structure 1372 of the PatchObject. The patches are applied to the top-level object. 1373 In addition to all the restrictions on patches specified there, the 1374 pointer also MUST NOT start with one of the following prefixes; any 1375 patch with a such a key MUST be ignored: 1377 o @type 1379 o due 1381 o duration 1383 o freeBusyStatus 1385 o localization 1387 o method 1389 o participants 1391 o prodId 1393 o progress 1395 o relatedTo 1397 o sequence 1399 o start 1401 o status 1403 o timeZone 1405 o uid 1407 o useDefaultAlerts 1409 Note that this specification does not define how to maintain validity 1410 of localized content. For example, a client application changing a 1411 JSCalendar object's title property might also need to update any 1412 localizations of this property. Client implementations SHOULD 1413 provide the means to manage localizations, but how to achieve this is 1414 specific to the application's workflow and requirements. 1416 5. Type-specific JSCalendar properties 1418 5.1. JSEvent properties 1420 In addition to the common JSCalendar object properties (Section 4) a 1421 JSEvent has the following properties: 1423 5.1.1. start 1425 Type: "LocalDate" e.g. "2015-09-02T00:00:00" 1427 The date/time the event would start in the event's time zone. 1429 A valid JSEvent MUST include this property. 1431 5.1.2. timeZone 1433 Type: "String|null" (optional, default:"null") 1435 The IANA Time Zone Database [3] name for the time zone the event is 1436 scheduled in, or "null" for floating time. If omitted, this MUST be 1437 presumed to be "null" (i.e. floating time). 1439 5.1.3. duration 1441 Type: "Duration", e.g. "P2DT3H" (optional, default: "PT0S") 1443 The zero or positive duration of the event in the event's start time 1444 zone. The same rules as for the iCalendar DURATION value type 1445 ([RFC5545]) apply: The duration of a week or a day in hours/minutes/ 1446 seconds may vary if it overlaps a period of discontinuity in the 1447 event's time zone, for example a change from standard time to 1448 daylight-savings time. Leap seconds MUST NOT be considered when 1449 computing an exact duration. When computing an exact duration, the 1450 greatest order time components MUST be added first, that is, the 1451 number of days MUST be added first, followed by the number of hours, 1452 number of minutes, and number of seconds. Fractional seconds MUST be 1453 added last. 1455 A JSEvent MAY involve start and end locations that are in different 1456 time zones (e.g. a trans-continental flight). This can be expressed 1457 using the *rel* and *timeZone* properties of the JSEvent's *location* 1458 objects. 1460 5.1.4. isAllDay 1462 Type: "Boolean" (optional, default:"false") 1464 Specifies if the event is an all day event, such as a birthday or 1465 public holiday. 1467 If *isAllDay* is true, then the following restrictions apply: 1469 o the *start* property MUST have a time component of "T00:00:00". 1471 o the *duration* property MUST NOT include non-zero time components 1472 (hours, minutes, or seconds). 1474 Note that all-day events MAY be bound to a specific time zone, as 1475 defined by the *timeZone* property. 1477 5.1.5. status 1479 Type: "String" (optional, default:"confirmed") 1481 The scheduling status (Section 4.4) of a JSEvent. If set, it MUST be 1482 one of: 1484 o "confirmed": Indicates the event is definite. 1486 o "cancelled": Indicates the event is cancelled. 1488 o "tentative": Indicates the event is tentative. 1490 5.2. JSTask properties 1492 In addition to the common JSCalendar object properties (Section 4) a 1493 JSTask has the following properties: 1495 5.2.1. due 1497 Type: "LocalDate" (optional) e.g. "2015-09-02T00:00:00" 1499 The date/time the task is due in the task's time zone. 1501 5.2.2. start 1503 Type: "LocalDate" (optional) e.g. "2015-09-02T00:00:00" 1505 The date/time the task should start in the task's time zone. 1507 5.2.3. timeZone 1509 Type: "String|null" (optional, default:"null") 1511 The IANA Time Zone Database name for the time zone the task is 1512 scheduled in, or "null" for floating time. If omitted, this MUST be 1513 presumed to be "null" (i.e. floating time). 1515 5.2.4. estimatedDuration 1517 Type: "Duration" (optional), e.g. "P2DT3H" 1519 Specifies the estimated positive duration of time the task takes to 1520 complete. 1522 5.2.5. statusUpdatedAt 1524 Type: "UTCDate" (optional), e.g. "2016-06-13T12:00:00Z" 1526 Specifies the date/time the task status properties was last updated. 1528 If the task is recurring and has future instances, a client may want 1529 to keep track of the last status update timestamp of a specific task 1530 recurrence, but leave other instances unchanged. One way to achieve 1531 this is by overriding the statusUpdatedAt property in the task 1532 *recurrenceOverrides*. However, this could produce a long list of 1533 timestamps for regularly recurring tasks. An alternative approach is 1534 to split the JSTask into a current, single instance of JSTask with 1535 this instance status update time and a future recurring instance. 1536 Also see the definition of the *relatedTo* on splitting. 1538 5.2.6. isAllDay 1540 Type: "Boolean" (optional, default:"false") 1542 Specifies if the task is an all day task. 1544 If *isAllDay* is true, then the *start* and *due* properties MUST 1545 have a time component of "T00:00:00". Note that the 1546 *estimatedDuration* property MAY contain a non-zero time duration. 1547 All-day tasks MAY be bound to a specific time zone, as defined by the 1548 *timeZone* property. 1550 5.2.7. progress 1552 In addition to the common properties of a *Participant* object 1553 (Section 4.4.5), a Participant within a JSTask supports the following 1554 property: 1556 o *progress*: "ParticipantProgress" (optional) The progress of the 1557 participant for this task, if known. This property MUST NOT be 1558 set if the *participationStatus* of this participant is any other 1559 value but "accepted". 1561 A *ParticipantProgress* object has the following properties: 1563 o *status*: "String" Describes the completion status of the 1564 participant's progress. 1566 The value MUST be at most one of the following values, registered 1567 in a future RFC, or a vendor-specific value: 1569 * "completed": The participant completed their task. 1571 * "in-process": The participant has started this task. 1573 * "failed": The participant failed to complete their task. 1575 o *timestamp*: "UTCDate" Describes the last time when the 1576 participant progress got updated. 1578 5.2.8. status 1580 Type: "String" 1582 Defines the overall status of this task. If omitted, the default 1583 status (Section 4.4) of a JSTask is defined as follows (in order of 1584 evaluation): 1586 o "completed": if all the *ParticipantProgress* status of the task 1587 participants is "completed". 1589 o "failed": if at least one *ParticipantProgress* status of the task 1590 participants is "failed". 1592 o "in-process": if at least one *ParticipantProgress* status of the 1593 task participants is "in-process". 1595 o "needs-action": If none of the other criteria match. 1597 If set, it MUST be one of: 1599 o "needs-action": Indicates the task needs action. 1601 o "completed": Indicates the task is completed. 1603 o "in-process": Indicates the task is in process. 1605 o "cancelled": Indicates the task is cancelled. 1607 o "pending": Indicates the task has been created and accepted for 1608 processing, but not yet started. 1610 o "failed": Indicates the task failed. 1612 5.3. JSGroup properties 1614 JSGroup supports the following JSCalendar properties (Section 4): 1616 o @type 1618 o uid 1620 o created 1622 o updated 1624 o categories 1626 o keywords 1628 o name 1630 o description 1632 o color 1634 o links 1636 as well as the following JSGroup-specific properties: 1638 5.3.1. entries 1640 Type: "String[JSTask|JSEvent]" 1642 A collection of group members. This is represented as a map of the 1643 *uid* property value to the JSCalendar object member having that uid. 1644 Implementations MUST ignore entries of unknown type. 1646 5.3.2. source 1648 Type: "String" (optional) 1650 The source from which updated versions of this group may be retrieved 1651 from. The value MUST be a URI. 1653 6. Conversion from and to iCalendar 1655 This section specifies which JSCalendar properties can be mapped from 1656 and to iCalendar format. Implementations SHOULD follow these 1657 conversion guidelines. Still, JSCalendar does not restrict itself to 1658 iCalendar and conversion between these two formats MAY be lossy. 1660 6.1. JSEvent 1662 The iCalendar counterpart to *JSEvent* is the VEVENT component type 1663 [RFC5545]. A VEVENT component that is a direct child of a VCALENDAR 1664 component is equivalent to a standalone JSEvent. A VEVENT component 1665 *within* a VEVENT maps to the entries of the JSEvent 1666 *recurrenceOverrides* property. 1668 +----------+--------------------------------------------------------+ 1669 | Property | iCalendar counterpart | 1670 +----------+--------------------------------------------------------+ 1671 | isAllDay | True, if the type of the DTSTART property in iCalendar | 1672 | | is DATE. When translating from JSCalendar the | 1673 | | iCalendar DTSTART property is of DATE value type, if | 1674 | | the *isAllDay* property is set to true and the | 1675 | | *timeZone* property is null. | 1676 | | | 1677 | start | Corresponds to the DTSTART property in iCalendar. Note | 1678 | | that time zone information is stored separately in | 1679 | | JSEvent. | 1680 | | | 1681 | timeZone | Corresponds to the TZID part of the DTSTART property | 1682 | | in iCalendar. If the event has a different end time | 1683 | | zone to start time zone, this should be added as a | 1684 | | JSCalendar *location* with just a *timeZone* property | 1685 | | and "rel="end"". | 1686 | | | 1687 | duration | Corresponds to the DURATION or DSTART+DTEND properties | 1688 | | in iCalendar. | 1689 +----------+--------------------------------------------------------+ 1691 Table 1: Translation between JSEvent and iCalendar 1693 6.2. JSTask 1695 The iCalendar counterpart to *JSTask* is the VTODO component type 1696 [RFC5545]. A VTODO component that is a direct child of a VCALENDAR 1697 component is equivalent to a standalone JSTask. A VTODO component 1698 *within* a master VTODO maps to the entries of the JSTask 1699 *recurrenceOverrides* property. 1701 +-------------------+-----------------------------------------------+ 1702 | Property | iCalendar counterpart | 1703 +-------------------+-----------------------------------------------+ 1704 | isAllDay | True, if the type of the DTSTART property in | 1705 | | iCalendar is DATE. When translating from | 1706 | | JSCalendar the iCalendar DTSTART property is | 1707 | | of DATE value type, if the *isAllDay* | 1708 | | property is set to true and the *timeZone* | 1709 | | property is null. | 1710 | | | 1711 | due | Corresponds to the DUE and DTSTART+DURATION | 1712 | | properties in iCalendar. When mapping | 1713 | | iCalendar VTODOs with DTSTART+DURATION, the | 1714 | | due date is the result of adding DURATION to | 1715 | | DTSTART in the DTSTART time zone. | 1716 | | | 1717 | start | Corresponds to the DTSTART property in | 1718 | | iCalendar. | 1719 | | | 1720 | timeZone | Corresponds to the TZID part of the | 1721 | | DTSTART/DUE properties in iCalendar. If the | 1722 | | task has a different end time zone to start | 1723 | | or due time zone, this should be added as a | 1724 | | JSCalendar *location* with just a *timeZone* | 1725 | | property and "rel="end"". | 1726 | | | 1727 | estimatedDuration | Corresponds to the ESTIMATED-DURATION | 1728 | | iCalendar property in the RFC draft | 1729 | | [draft-apthorp-ical-tasks]. | 1730 | | | 1731 | statusUpdatedAt | Maps to the COMPLETED iCalendar property. The | 1732 | | JSTask status property MUST have value | 1733 | | "completed". | 1734 | | | 1735 | progress | Corresponds to the PARTSTAT and COMPLETED | 1736 | | properties in iCalendar, including the | 1737 | | definitions in the RFC draft | 1738 | | [draft-apthorp-ical-tasks]. | 1739 | | | 1740 | status | Corresponds to the STATUS property in | 1741 | | iCalendar, including the definitions in the | 1742 | | RFC draft [draft-apthorp-ical-tasks]. | 1743 +-------------------+-----------------------------------------------+ 1745 Table 2: Translation between JSTask and iCalendar 1747 6.3. JSGroup 1749 A JSGroup converts to a iCalendar VCALENDAR containing VEVENT or 1750 VTODO components. 1752 +----------+--------------------------------------------------------+ 1753 | Property | iCalendar counterpart | 1754 +----------+--------------------------------------------------------+ 1755 | entries | The VEVENT and VTODO components within a top-level | 1756 | | VCALENDAR component. | 1757 | | | 1758 | source | Corresponds to the SOURCE property in iCalendar. | 1759 +----------+--------------------------------------------------------+ 1761 Table 3: Translation between JSGroup and iCalendar 1763 6.4. Common properties 1765 +------------------------+------------------------------------------+ 1766 | Property | iCalendar counterpart | 1767 +------------------------+------------------------------------------+ 1768 | alerts | An *Alert* corresponds to the VALARM | 1769 | | component in iCalendar, where the | 1770 | | *action* is determined by the iCalendar | 1771 | | ACTION property value (e.g., both | 1772 | | "DISPLAY" and "AUDIO" actions map to a | 1773 | | JSCalendar *display* action, and | 1774 | | similarly for "EMAIL"). The | 1775 | | *relativeTo* and *offset* properties | 1776 | | corresponds to the iCalendar TRIGGER | 1777 | | property. | 1778 | | | 1779 | categories | Corresponds to the CONCEPT property in | 1780 | | iCalendar, see in the RFC draft | 1781 | | [draft-ietf-calext-ical-relations]. | 1782 | | | 1783 | color | Corresponds to the COLOR property in | 1784 | | iCalendar, as specified in [RFC7986]. | 1785 | | | 1786 | created | Corresponds to the CREATED property in | 1787 | | iCalendar. | 1788 | | | 1789 | description | Corresponds to the DESCRIPTION property | 1790 | | and its ALTREP parameters in iCalendar. | 1791 | | | 1792 | descriptionContentType | Implementation-specific. | 1793 | | | 1794 | freeBusyStatus | Corresponds to the TRANSP property in | 1795 | | iCalendar. | 1796 | | | 1797 | keywords | Corresponds to the CATEGORIES property | 1798 | | in iCalendar, as specified in [RFC7986]. | 1799 | | | 1800 | links | Corresponds to the ATTACH ([RFC5545]) or | 1801 | | IMAGE ([RFC7986]) properties with a URI | 1802 | | value type set to the link "href". | 1803 | | ([RFC7986]). The *type* property | 1804 | | corresponds to the FMTTYPE parameter, | 1805 | | the *size* property to the SIZE | 1806 | | parameter. Mapping all other properties | 1807 | | is implementation-specific. | 1808 | | | 1809 | locale | Corresponds to the LANGUAGE parameter in | 1810 | | iCalendar, which is added to individual | 1811 | | properties. When converting from | 1812 | | iCalendar, one language must be picked | 1813 | | as the main locale for the object, and | 1814 | | all properties in other languages moved | 1815 | | to the localizations JSEvent property. | 1816 | | | 1817 | localizations | Implementation-specific. | 1818 | | | 1819 | locations | See Section 6.5. | 1820 | | | 1821 | method | Corresponds to the METHOD property of | 1822 | | the embedding VCALENDAR in iCalendar. | 1823 | | | 1824 | participants | See Section 6.5. | 1825 | | | 1826 | priority | Corresponds to the PRIORITY property in | 1827 | | iCalendar. | 1828 | | | 1829 | privacy | Corresponds to the CLASS property in | 1830 | | iCalendar. | 1831 | | | 1832 | prodId | Corresponds to the PRODID property in | 1833 | | iCalendar. | 1834 | | | 1835 | recurrenceOverrides | Corresponds to the RDATE and EXDATE | 1836 | | properties in iCalendar, plus VEVENT | 1837 | | (for JSEvent) or VTODO (for JSTask) | 1838 | | instances with a recurrence-id. | 1839 | | | 1840 | recurrenceRule | Corresponds to the RRULE property in | 1841 | | iCalendar. See the property definition | 1842 | | at section Section 4.3.1 how to map a | 1843 | | RRULE value. | 1844 | | | 1845 | relatedTo | Corresponds to the RELATED-TO property | 1846 | | in iCalendar. | 1847 | | | 1848 | replyTo | An iCalendar ORGANIZER with a mailto: | 1849 | | URI mapped to the "imip" method, or any | 1850 | | other URI mapped to the "other" method. | 1851 | | Mapping multiple methods is | 1852 | | implementation-specific. | 1853 | | | 1854 | sequence | Corresponds to the SEQUENCE property in | 1855 | | iCalendar. | 1856 | | | 1857 | status | Corresponds to the STATUS property in | 1858 | | iCalendar (converted to lower-case). | 1859 | | | 1860 | title | Corresponds to the SUMMARY property in | 1861 | | iCalendar. | 1862 | | | 1863 | uid | Corresponds to the UID property in | 1864 | | iCalendar. | 1865 | | | 1866 | updated | Corresponds to the DTSTAMP and LAST- | 1867 | | MODIFIED properties in iCalendar. (These | 1868 | | are only different in the iTIP case, and | 1869 | | the difference is not actually useful.) | 1870 +------------------------+------------------------------------------+ 1872 Table 4: Translation between JSCalendar and iCalendar 1874 6.5. Locations and participants 1876 Both JSCalendar participants and locations have counterparts in 1877 iCalendar but provide richer representation. 1879 The following table outlines translation of JSCalendar participants. 1880 Where iCalendar has distinct properties for ORGANIZER and ATTENDEE, 1881 these are merged in JSCalendar into the Participant object type. 1883 +---------------------+---------------------------------------------+ 1884 | Property | iCalendar counterpart | 1885 +---------------------+---------------------------------------------+ 1886 | delegatedFrom | the DELEGATED-FROM parameter | 1887 | | | 1888 | delegatedTo | the DELEGATED-TO parameter | 1889 | | | 1890 | expectReply | the RSVP parameter | 1891 | | | 1892 | email | The value of the EMAIL parameter of the | 1893 | | ORGANIZER or ATTENDEE property, if defined. | 1894 | | Otherwise the property value, if it is a | 1895 | | mailto: URI. | 1896 | | | 1897 | sendTo | An iCalendar ATTENDEE with a mailto: URI | 1898 | | mapped to the "imip" method, or any other | 1899 | | URI mapped to the "other" method. Mapping | 1900 | | multiple methods is implementation- | 1901 | | specific. | 1902 | | | 1903 | kind | the CUTYPE parameter | 1904 | | | 1905 | linkIds | Implementation-specific. | 1906 | | | 1907 | locationId | Implementation-specific. When mapping from | 1908 | | iCalendar to JSCalendar this may be the | 1909 | | JSCalendar identifier of a CONFERENCE | 1910 | | property that has the MODERATOR feature | 1911 | | defined in its FEATURE parameter values. If | 1912 | | multiple such CONFERENCE properties are | 1913 | | defined in iCalendar, then the one with the | 1914 | | most interactive features is chosen. | 1915 | | | 1916 | memberOf | the MEMBER parameter | 1917 | | | 1918 | name | the CN parameter | 1919 | | | 1920 | attendance | Maps to the standard iCalendar ROLE | 1921 | | parameter values REQ-PARTICIPANT, OPT- | 1922 | | PARTICIPANT and NON-PARTICIPANT. | 1923 | | | 1924 | roles | The "chair" role maps to the standard | 1925 | | iCalendar ROLE parameter value "chair", | 1926 | | with an implicit participant of value | 1927 | | "required". The mapping of non-required | 1928 | | chairs and other roles is implementation- | 1929 | | specific, but using "x-name" parameter | 1930 | | values is recommended. | 1931 | | | 1932 | participationStatus | the PARTSTAT parameter | 1933 | | | 1934 | scheduleSequence | the SEQUENCE property of the participant's | 1935 | | latest iMIP message | 1936 | | | 1937 | scheduleUpdated | the DTSTAMP property of the participant's | 1938 | | latest iMIP message | 1939 +---------------------+---------------------------------------------+ 1941 Table 5: Translation of Participant between JSCalendar and iCalendar 1943 The iCalendar counterpart for JSCalendar Location objects is the 1944 iCalendar [RFC5545] LOCATION property, or implementation-specific. 1946 +-------------+-----------------------------------------------------+ 1947 | Property | iCalendar counterpart | 1948 +-------------+-----------------------------------------------------+ 1949 | name | Corresponds to the LOCATION property value. | 1950 | | | 1951 | description | Implementation-specific. | 1952 | | | 1953 | rel | Implementation-specific. | 1954 | | | 1955 | timeZone | Implementation-specific. | 1956 | | | 1957 | coordinates | Implementation-specific. Consider using a GEO | 1958 | | iCalendar property, along with one LOCATION. | 1959 | | | 1960 | uri | Corresponds to the LOCATION ALTREP parameter. | 1961 | | | 1962 | linkIds | Implementation-specific. | 1963 +-------------+-----------------------------------------------------+ 1965 Table 6: Translation of Location between JSCalendar and iCalendar 1967 The iCalendar counterpart for JSCalendar VirtualLocation objects is 1968 the iCalendar [RFC7986] CONFERENCE property, or implementation- 1969 specific. 1971 +--------------+--------------------------------------------------+ 1972 | Property | iCalendar counterpart | 1973 +--------------+--------------------------------------------------+ 1974 | name | Corresponds to the CONFERENCE LABEL parameter. | 1975 | | | 1976 | description | Implementation-specific. | 1977 | | | 1978 | uri | Corresponds to the CONFERENCE property value. | 1979 +--------------+--------------------------------------------------+ 1981 Table 7: Translation of VirtualLocation between JSCalendar and 1982 iCalendar 1984 6.6. Unknown properties 1986 Both JSCalendar and iCalendar calendar objects may contain properties 1987 that are not expressible in the other format. This specification 1988 does not mandate how to preserve these properties. Instead, it 1989 leaves negotiation on how to treat unknown properties to client and 1990 server implementations and their protocol used to exchange calendar 1991 objects. 1993 Two notable options to represent and preserve arbitrary iCalendar 1994 object properties in JSCalendar are: 1996 o *JCal*: Define iCalendar properties in JCal format ([RFC7265]) in 1997 a vendor-specific property of the JCalendar object. The JCal- 1998 formatted value may either only contain iCalendar properties that 1999 were not mapped to JSCalendar properties, or contain the complete 2000 iCalendar object representation. 2002 o *Alternate link*: Define an alternate link (Section 4.2.6) value 2003 pointing to the iCalendar representation of the JSCalendar object. 2004 E.g. the alternative representation of a VEVENT would be 2005 represented as a link with rel "alternate" and type "text/ 2006 calendar;component=VEVENT". 2008 7. JSCalendar object examples 2010 The following examples illustrate several aspects of the JSCalendar 2011 data model and format. The examples may omit mandatory or additional 2012 properties, which is indicated by a placeholder property with key 2013 "...". While most of the examples use calendar event objects, they 2014 are also illustrative for tasks. 2016 7.1. Simple event 2018 This example illustrates a simple one-time event. It specifies a 2019 one-time event that begins on January 15, 2018 at 1pm New York local 2020 time and ends after 1 hour. 2022 { 2023 "@type": "jsevent", 2024 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 2025 "updated": "2018-01-15T18:00:00Z", 2026 "title": "Some event", 2027 "start": "2018-01-15T13:00:00", 2028 "timeZone": "America/New_York", 2029 "duration": "PT1H" 2030 } 2032 7.2. Simple task 2034 This example illustrates a simple task for a plain to-do item. 2036 { 2037 "@type": "jstask", 2038 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 2039 "updated": "2018-01-15T18:00:00Z", 2040 "title": "Do something" 2041 } 2043 7.3. Simple group 2045 This example illustrates a simple calendar object group that contains 2046 an event and a task. 2048 { 2049 "@type": "jsgroup", 2050 "uid": "2a358cee-6489-4f14-a57f-c104db4dc343", 2051 "updated": "2018-01-15T18:00:00Z", 2052 "name": "A simple group", 2053 "entries": [ 2054 { 2055 "@type": "jsevent", 2056 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f1", 2057 "updated": "2018-01-15T18:00:00Z", 2058 "title": "Some event", 2059 "start": "2018-01-15T13:00:00", 2060 "timeZone": "America/New_York", 2061 "duration": "PT1H" 2062 }, 2063 { 2064 "@type": "jstask", 2065 "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", 2066 "updated": "2018-01-15T18:00:00Z", 2067 "title": "Do something" 2068 } 2069 ] 2070 } 2072 7.4. All-day event 2074 This example illustrates an event for an international holiday. It 2075 specifies an all-day event on April 1 that occurs every year since 2076 the year 1900. 2078 { 2079 "...": "", 2080 "title": "April Fool's Day", 2081 "isAllDay": true, 2082 "start": "1900-04-01T00:00:00", 2083 "duration": "P1D", 2084 "recurrenceRule": { 2085 "frequency": "yearly" 2086 } 2087 } 2089 7.5. Task with a due date 2091 This example illustrates a task with a due date. It is a reminder to 2092 buy groceries before 6pm Vienna local time on January 19, 2018. The 2093 calendar user expects to need 1 hour for shopping. 2095 { 2096 "...": "", 2097 "title": "Buy groceries", 2098 "due": "2018-01-19T18:00:00", 2099 "timeZone": "Europe/Vienna", 2100 "estimatedDuration": "PT1H" 2101 } 2103 7.6. Event with end time zone 2105 This example illustrates the use of end time zones by use of an 2106 international flight. The flight starts on April 1, 2018 at 9am in 2107 Berlin local time. The duration of the flight is scheduled at 10 2108 hours 30 minutes. The time at the flights destination is in the same 2109 time zone as Tokyo. Calendar clients could use the end time zone to 2110 display the arrival time in Tokyo local time and highlight the time 2111 zone difference of the flight. The location names can serve as input 2112 for navigation systems. 2114 { 2115 "...": "", 2116 "title": "Flight XY51 to Tokyo", 2117 "start": "2018-04-01T09:00:00", 2118 "timeZone": "Europe/Berlin", 2119 "duration": "PT10H30M", 2120 "locations": { 2121 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2122 "rel": "start", 2123 "name": "Frankfurt Airport (FRA)" 2124 }, 2125 "c2c7ac67-dc13-411e-a7d4-0780fb61fb08": { 2126 "rel": "end", 2127 "name": "Narita International Airport (NRT)", 2128 "timeZone": "Asia/Tokyo" 2129 } 2130 } 2131 } 2133 7.7. Floating-time event (with recurrence) 2135 This example illustrates the use of floating-time. Since January 1, 2136 2018, a calendar user blocks 30 minutes every day to practice Yoga at 2137 7am local time, in whatever time zone the user is located on that 2138 date. 2140 { 2141 "...": "", 2142 "title": "Yoga", 2143 "start": "2018-01-01T07:00:00", 2144 "duration": "PT30M", 2145 "recurrenceRule": { 2146 "frequency": "daily" 2147 } 2148 } 2150 7.8. Event with multiple locations and localization 2152 This example illustrates an event that happens at both a physical and 2153 a virtual location. Fans can see a live convert on premises or 2154 online. The event title and descriptions are localized. (Note: the 2155 localization of the event description contains an UTF-8 encoded 2156 German Umlaut. This character may have been replaced with ASCII 2157 characters in the plain-text rendering of this RFC document) 2158 { 2159 "...": "", 2160 "title": "Live from Music Bowl: The Band", 2161 "description": "Go see the biggest music event ever!", 2162 "locale": "en", 2163 "start": "2018-07-04T17:00:00", 2164 "timeZone": "America/New_York", 2165 "duration": "PT3H", 2166 "locations": { 2167 "c0503d30-8c50-4372-87b5-7657e8e0fedd": { 2168 "name": "The Music Bowl", 2169 "description": "Music Bowl, Central Park, New York", 2170 "coordinates": "geo:40.7829,73.9654" 2171 } 2172 }, 2173 "virtualLocations": { 2174 "6f3696c6-1e07-47d0-9ce1-f50014b0041a": { 2175 "name": "Free live Stream from Music Bowl", 2176 "uri": "https://stream.example.com/the_band_2018" 2177 } 2178 }, 2179 "localizations": { 2180 "de": { 2181 "title": "Live von der Music Bowl: The Band!", 2182 "description": "Schau dir das groesste Musikereignis an!", 2183 "virtualLocations/6f3696c6-1e07-47d0-9ce1-f50014b0041a/name": 2184 "Gratis Live-Stream aus der Music Bowl" 2185 } 2186 } 2187 } 2189 7.9. Recurring event with overrides 2191 This example illustrates the use of recurrence overrides. A math 2192 course at a University is held for the first time on January 8, 2018 2193 at 9am London time and occurs every week until June 25, 2018. Each 2194 lecture lasts for one hour and 30 minutes and is located at the 2195 Mathematics department. This event has exceptional occurrences: at 2196 the last occurrence of the course is an exam, which lasts for 2 hours 2197 and starts at 10am. Also, the location of the exam differs from the 2198 usual location. On April 2 no course is held. On January 5 at 2pm 2199 is an optional introduction course, that occurs before the first 2200 regular lecture. 2202 { 2203 "...": "", 2204 "title": "Calculus I", 2205 "start": "2018-01-08T09:00:00", 2206 "timeZone": "Europe/London", 2207 "duration": "PT1H30M", 2208 "locations": { 2209 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2210 "title": "Math lab room 1", 2211 "description": "Math Lab I, Department of Mathematics" 2212 } 2213 }, 2214 "recurrenceRule": { 2215 "frequency": "weekly", 2216 "until": "2018-06-25T09:00:00" 2217 }, 2218 "recurrenceOverrides": { 2219 "2018-01-05T14:00:00": { 2220 "title": "Introduction to Calculus I (optional)" 2221 }, 2222 "2018-04-02T09:00:00": { 2223 "excluded": "true" 2224 }, 2225 "2018-06-25T09:00:00": { 2226 "title": "Calculus I Exam", 2227 "start": "2018-06-25T10:00:00", 2228 "duration": "PT2H", 2229 "locations": { 2230 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2231 "title": "Big Auditorium", 2232 "description": "Big Auditorium, Other Road" 2233 } 2234 } 2235 } 2236 } 2237 } 2239 7.10. Recurring event with participants 2241 This example illustrates scheduled events. A team meeting occurs 2242 every week since January 8, 2018 at 9am Johannesburg time. The event 2243 owner also chairs the event. Participants meet in a virtual meeting 2244 room. An attendee has accepted the invitation, but on March 8, 2018 2245 he is unavailable and declined participation for this occurrence. 2247 { 2248 "...": "", 2249 "title": "FooBar team meeting", 2250 "start": "2018-01-08T09:00:00", 2251 "timeZone": "Africa/Johannesburg", 2252 "duration": "PT1H", 2253 "locations": { 2254 "2a358cee-6489-4f14-a57f-c104db4dc2f1": { 2255 "title": "ChatMe meeting room", 2256 "rel": "virtual", 2257 "features": [ 2258 "audio", 2259 "chat", 2260 "video" 2261 ], 2262 "uri": "https://chatme.example.com?id=1234567" 2263 } 2264 }, 2265 "recurrenceRule": { 2266 "frequency": "weekly" 2267 }, 2268 "replyTo": { 2269 "imip": "zoe@foobar.example.com" 2270 }, 2271 "participants": { 2272 "tom@foobar.example.com": { 2273 "name": "Tom Tool", 2274 "email": "tom@foobar.example.com", 2275 "participationStatus": "accepted", 2276 "roles": [ 2277 "attendee" 2278 ] 2279 }, 2280 "zoe@foobar.example.com": { 2281 "name": "Zoe Zelda", 2282 "email": "zoe@foobar.example.com", 2283 "participationStatus": "accepted", 2284 "roles": [ 2285 "owner", 2286 "chair" 2287 ] 2288 }, 2289 "...": "" 2290 }, 2291 "recurrenceOverrides": { 2292 "2018-03-08T09:00:00": { 2293 "participants/tom@foobar.example.com/participationStatus": 2294 "declined" 2295 } 2296 } 2297 } 2299 8. Security Considerations 2301 The use of JSON as a format does have its own inherent security risks 2302 as discussed in Section 12 of [RFC8259]. Even though JSON is 2303 considered a safe subset of JavaScript, it should be kept in mind 2304 that a flaw in the parser processing JSON could still impose a 2305 threat, which doesn't arise with conventional iCalendar data. 2307 With this in mind, a parser for JSON data aware of the security 2308 implications should be used for the format described in this 2309 document. For example, the use of JavaScript's "eval()" function is 2310 considered an unacceptable security risk, as described in Section 12 2311 of[RFC8259]. A native parser with full awareness of the JSON format 2312 should be preferred. 2314 9. IANA Considerations 2316 This document amends the "application/calendar" MIME media type 2317 defined in [RFC7265]. 2319 New optional parameter: "type" with value being one of "jsevent", 2320 "jstask", "jsgroup". The parameter MUST NOT occur more than once. 2322 10. Acknowledgments 2324 The authors would like to thank the members of CalConnect for their 2325 valuable contributions. This specification originated from the work 2326 of the API technical committee of CalConnect, the Calendaring and 2327 Scheduling Consortium. 2329 11. References 2331 11.1. Normative References 2333 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2334 Requirement Levels", BCP 14, RFC 2119, 2335 DOI 10.17487/RFC2119, March 1997, 2336 . 2338 [RFC2392] Levinson, E., "Content-ID and Message-ID Uniform Resource 2339 Locators", RFC 2392, DOI 10.17487/RFC2392, August 1998, 2340 . 2342 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 2343 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 2344 . 2346 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 2347 Resource Identifier (URI): Generic Syntax", STD 66, 2348 RFC 3986, DOI 10.17487/RFC3986, January 2005, 2349 . 2351 [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally 2352 Unique IDentifier (UUID) URN Namespace", RFC 4122, 2353 DOI 10.17487/RFC4122, July 2005, 2354 . 2356 [RFC4648] Josefsson, S., "The Base16, Base32, and Base64 Data 2357 Encodings", RFC 4648, DOI 10.17487/RFC4648, October 2006, 2358 . 2360 [RFC4791] Daboo, C., Desruisseaux, B., and L. Dusseault, 2361 "Calendaring Extensions to WebDAV (CalDAV)", RFC 4791, 2362 DOI 10.17487/RFC4791, March 2007, 2363 . 2365 [RFC5545] Desruisseaux, B., Ed., "Internet Calendaring and 2366 Scheduling Core Object Specification (iCalendar)", 2367 RFC 5545, DOI 10.17487/RFC5545, September 2009, 2368 . 2370 [RFC5546] Daboo, C., Ed., "iCalendar Transport-Independent 2371 Interoperability Protocol (iTIP)", RFC 5546, 2372 DOI 10.17487/RFC5546, December 2009, 2373 . 2375 [RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying 2376 Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, 2377 September 2009, . 2379 [RFC5870] Mayrhofer, A. and C. Spanring, "A Uniform Resource 2380 Identifier for Geographic Locations ('geo' URI)", 2381 RFC 5870, DOI 10.17487/RFC5870, June 2010, 2382 . 2384 [RFC6047] Melnikov, A., Ed., "iCalendar Message-Based 2385 Interoperability Protocol (iMIP)", RFC 6047, 2386 DOI 10.17487/RFC6047, December 2010, 2387 . 2389 [RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type 2390 Specifications and Registration Procedures", BCP 13, 2391 RFC 6838, DOI 10.17487/RFC6838, January 2013, 2392 . 2394 [RFC6901] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., 2395 "JavaScript Object Notation (JSON) Pointer", RFC 6901, 2396 DOI 10.17487/RFC6901, April 2013, 2397 . 2399 [RFC7265] Kewisch, P., Daboo, C., and M. Douglass, "jCal: The JSON 2400 Format for iCalendar", RFC 7265, DOI 10.17487/RFC7265, May 2401 2014, . 2403 [RFC7493] Bray, T., Ed., "The I-JSON Message Format", RFC 7493, 2404 DOI 10.17487/RFC7493, March 2015, 2405 . 2407 [RFC7529] Daboo, C. and G. Yakushev, "Non-Gregorian Recurrence Rules 2408 in the Internet Calendaring and Scheduling Core Object 2409 Specification (iCalendar)", RFC 7529, 2410 DOI 10.17487/RFC7529, May 2015, 2411 . 2413 [RFC7986] Daboo, C., "New Properties for iCalendar", RFC 7986, 2414 DOI 10.17487/RFC7986, October 2016, 2415 . 2417 [RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data 2418 Interchange Format", STD 90, RFC 8259, 2419 DOI 10.17487/RFC8259, December 2017, 2420 . 2422 [RFC8288] Nottingham, M., "Web Linking", RFC 8288, 2423 DOI 10.17487/RFC8288, October 2017, 2424 . 2426 11.2. Informative References 2428 [draft-apthorp-ical-tasks] 2429 "Task Extensions to iCalendar", 2430 . 2432 [draft-ietf-calext-ical-relations] 2433 "Support for iCalendar Relationships", 2434 . 2437 [MIME] "IANA Media Types", . 2440 11.3. URIs 2442 [1] https://www.iana.org/assignments/link-relations/link- 2443 relations.xhtml 2445 [2] https://www.w3.org/TR/2011/REC-css3-color-20110607/#svg-color 2447 [3] http://www.iana.org/time zones 2449 Authors' Addresses 2451 Neil Jenkins 2452 FastMail 2453 PO Box 234 2454 Collins St West 2455 Melbourne VIC 8007 2456 Australia 2458 Email: neilj@fastmailteam.com 2459 URI: https://www.fastmail.com 2461 Robert Stepanek 2462 FastMail 2463 PO Box 234 2464 Collins St West 2465 Melbourne VIC 8007 2466 Australia 2468 Email: rsto@fastmailteam.com 2469 URI: https://www.fastmail.com