rfc8984xml2.original.xml | rfc8984.xml | |||
---|---|---|---|---|
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | |||
<!DOCTYPE rfc SYSTEM "rfc2629.dtd"> | <!DOCTYPE rfc SYSTEM "rfc2629-xhtml.ent"> | |||
<rfc ipr="trust200902" category="std" docName="draft-ietf-calext-jscalendar-32"> | ||||
<?rfc toc="yes"?> | <rfc xmlns:xi="http://www.w3.org/2001/XInclude" ipr="trust200902" docName="d | |||
<?rfc symrefs="yes"?> | raft-ietf-calext-jscalendar-32" number="8984" obsoletes="" updates="" | |||
<?rfc sortrefs="yes"?> | submissionType="IETF" category="std" consensus="true" xml:lang="en" tocInclude=" | |||
<?rfc compact="no"?> | true" | |||
<?rfc subcompact="no"?> | symRefs="true" sortRefs="true" version="3"> | |||
<?rfc private=""?> | ||||
<?rfc topblock="yes"?> | <!-- xml2rfc v2v3 conversion 3.5.0 --> | |||
<?rfc comments="no"?> | ||||
<front> | <front> | |||
<title abbrev="JSCalendar">JSCalendar: A JSON representation of calendar dat | <title abbrev="JSCalendar">JSCalendar: A JSON Representation of Calendar Dat | |||
a</title> | a</title> | |||
<author initials="N.M." surname="Jenkins" fullname="Neil Jenkins"> | <seriesInfo name="RFC" value="8984"/> | |||
<author initials="N." surname="Jenkins" fullname="Neil Jenkins"> | ||||
<organization>Fastmail</organization> | <organization>Fastmail</organization> | |||
<address> | <address> | |||
<postal> | <postal> | |||
<street>PO Box 234</street> | <street>P.O. Box 234</street> | |||
<street>Collins St West</street> | <extaddr>Collins St. West</extaddr> | |||
<city>Melbourne</city> | <city>Melbourne</city> | |||
<code>VIC 8007</code> | <code>VIC 8007</code> | |||
<country>Australia</country> | <country>Australia</country> | |||
<region /> | <region/> | |||
</postal> | </postal> | |||
<phone /> | <phone/> | |||
<email>neilj@fastmailteam.com</email> | <email>neilj@fastmailteam.com</email> | |||
<uri>https://www.fastmail.com</uri> | <uri>https://www.fastmail.com</uri> | |||
</address> | </address> | |||
</author> | </author> | |||
<author initials="R." surname="Stepanek" fullname="Robert Stepanek"> | <author initials="R." surname="Stepanek" fullname="Robert Stepanek"> | |||
<organization>Fastmail</organization> | <organization>Fastmail</organization> | |||
<address> | <address> | |||
<postal> | <postal> | |||
<street>PO Box 234</street> | <street>P.O. Box 234</street> | |||
<street>Collins St West</street> | <extaddr>Collins St. West</extaddr> | |||
<city>Melbourne</city> | <city>Melbourne</city> | |||
<code>VIC 8007</code> | <code>VIC 8007</code> | |||
<country>Australia</country> | <country>Australia</country> | |||
<region /> | <region/> | |||
</postal> | </postal> | |||
<email>rsto@fastmailteam.com</email> | <email>rsto@fastmailteam.com</email> | |||
<uri>https://www.fastmail.com</uri> | <uri>https://www.fastmail.com</uri> | |||
</address> | </address> | |||
</author> | </author> | |||
<date year="2020" month="October" day="16" /> | <date year="2021" month="July"/> | |||
<area>Applications</area> | <area>Applications</area> | |||
<workgroup>Calendaring extensions</workgroup> | <workgroup>Calendaring extensions</workgroup> | |||
<keyword>JSON</keyword> | <keyword>JSON</keyword> | |||
<keyword>iCalendar</keyword> | <keyword>iCalendar</keyword> | |||
<keyword>calendar</keyword> | <keyword>calendar</keyword> | |||
<keyword>events</keyword> | <keyword>events</keyword> | |||
<keyword>date</keyword> | <keyword>date</keyword> | |||
<keyword>time</keyword> | <keyword>time</keyword> | |||
<abstract> | <abstract> | |||
<t>This specification defines a data model and JSON representation of cale ndar data that can be used for storage and data exchange in a calendaring and sc heduling environment. It aims to be an alternative and, over time, successor to the widely deployed iCalendar data format, and to be unambiguous, extendable, an d simple to process. In contrast to the jCal format, which is also JSON-based, J SCalendar is not a direct mapping from iCalendar, but defines the data model ind ependently and expands semantics where appropriate.</t> | <t>This specification defines a data model and JSON representation of cale ndar data that can be used for storage and data exchange in a calendaring and sc heduling environment. It aims to be an alternative and, over time, successor to the widely deployed iCalendar data format. It also aims to be unambiguous, exten dable, and simple to process. In contrast to the jCal format, which is also base d on JSON, JSCalendar is not a direct mapping from iCalendar but defines the dat a model independently and expands semantics where appropriate.</t> | |||
</abstract> | </abstract> | |||
</front> | </front> | |||
<middle> | <middle> | |||
<section anchor="introduction" title="Introduction"> | <section anchor="introduction" numbered="true" toc="default"> | |||
<t>This document defines a data model for calendar event and task objects, | <name>Introduction</name> | |||
or groups of such objects, in electronic calendar applications and systems. The | <t>This document defines a data model for calendar event and task objects, | |||
format aims to be unambiguous, extendable and simple to process.</t> | or groups of such objects, in electronic calendar applications and systems. The | |||
format aims to be unambiguous, extendable, and simple to process.</t> | ||||
<t>The key design considerations for this data model are as follows: | <t>The key design considerations for this data model are as follows: | |||
<list style="symbols"> | ||||
<t>The attributes of the calendar entry represented must be described | ||||
as simple key-value pairs. Simple events are simple to represent; complex events | ||||
can be modelled accurately.</t> | ||||
<t>Wherever possible, there should be only one way to express the desi | ||||
red semantics, reducing complexity.</t> | ||||
<t>The data model should avoid ambiguities, which often lead to intero | ||||
perability issues between implementations.</t> | ||||
<t>The data model should be generally compatible with the iCalendar da | ||||
ta format <xref target="RFC5545" /> <xref target="RFC7986" /> and extensions, bu | ||||
t the specification should add new attributes where the iCalendar format current | ||||
ly lacks expressivity, and drop seldom-used, obsolete, or redundant properties. | ||||
This means translation with no loss of semantics should be easy with most common | ||||
iCalendar files.</t> | ||||
<t>Extensions, such as new properties and components, should not requi | ||||
re updates to this document.</t> | ||||
</list> | ||||
</t> | </t> | |||
<ul spacing="normal"> | ||||
<li>The attributes of the calendar entry represented must be described a | ||||
s simple key-value pairs. Simple events are simple to represent; complex events | ||||
can be modeled accurately.</li> | ||||
<li>Wherever possible, there should be only one way to express the desir | ||||
ed semantics, reducing complexity.</li> | ||||
<li>The data model should avoid ambiguities, which often lead to interop | ||||
erability issues between implementations.</li> | ||||
<t>The representation of this data model is defined in the I-JSON format < | <li>The data model should be generally compatible with the iCalendar dat | |||
xref target="RFC7493" />, which is a strict subset of the JavaScript Object Nota | a format <xref target="RFC5545" format="default"/> <xref target="RFC7986" format | |||
tion (JSON) Data Interchange Format <xref target="RFC8259" />. Using JSON is mos | ="default"/> and extensions, but the specification should add new attributes whe | |||
tly a pragmatic choice: its widespread use makes JSCalendar easier to adopt, and | re the iCalendar format currently lacks expressivity, and drop seldom-used, obso | |||
the ready availability of production-ready JSON implementations eliminates a wh | lete, or redundant properties. This means translation with no loss of semantics | |||
ole category of parser-related interoperability issues, which iCalendar has ofte | should be easy with most common iCalendar files.</li> | |||
n suffered from.</t> | <li>Extensions, such as new properties and components, should not requir | |||
e updates to this document.</li> | ||||
<section anchor="relation-to-icalendar" title="Motivation and Relation to | </ul> | |||
iCalendar and jCal"> | <t>The representation of this data model is defined in the Internet JSON ( | |||
<t>The iCalendar data format <xref target="RFC5545" />, a widely deploye | I-JSON) format <xref target="RFC7493" format="default"/>, which is a strict subs | |||
d interchange format for calendaring and scheduling data, has served calendaring | et of the JSON data interchange format <xref target="RFC8259" format="default"/> | |||
vendors for a long while, but contains some ambiguities and pitfalls that can n | . Using JSON is mostly a pragmatic choice: its widespread use makes JSCalendar e | |||
ot be overcome without backward-incompatible changes.</t> | asier to adopt and the ready availability of production-ready JSON implementatio | |||
ns eliminates a whole category of parser-related interoperability issues, which | ||||
iCalendar has often suffered from.</t> | ||||
<section anchor="relation-to-icalendar" numbered="true" toc="default"> | ||||
<name>Motivation and Relation to iCalendar and jCal</name> | ||||
<t>The iCalendar data format <xref target="RFC5545" format="default"/>, | ||||
a widely deployed interchange format for calendaring and scheduling data, has se | ||||
rved calendaring vendors for a long time but contains some ambiguities and pitfa | ||||
lls that cannot be overcome without backward-incompatible changes.</t> | ||||
<t>Sources of implementation errors include the following: | <t>Sources of implementation errors include the following: | |||
<list style="symbols"> | ||||
<t>iCalendar defines various formats for local times, UTC time, and | ||||
dates.</t> | ||||
<t>iCalendar requires custom time zone definitions within a single c | ||||
alendar component.</t> | ||||
<t>iCalendar's definition of recurrence rules is ambiguous and has r | ||||
esulted in differing understandings even between experienced calendar developers | ||||
.</t> | ||||
<t>The iCalendar format itself causes interoperability issues due to | ||||
misuse of CRLF-terminated strings, line continuations, and subtle differences a | ||||
mong iCalendar parsers.</t> | ||||
</list> | ||||
</t> | </t> | |||
<ul spacing="normal"> | ||||
<t>In recent years, many new products and services have appeared that wi | <li>iCalendar defines various formats for local times, UTC, and dates. | |||
sh to use a JSON representation of calendar data within their APIs. The JSON for | </li> | |||
mat for iCalendar data, <xref target="RFC7265">jCal</xref>, is a direct mapping | <li>iCalendar requires custom time zone definitions within a single ca | |||
between iCalendar and JSON. In its effort to represent full iCalendar semantics, | lendar component.</li> | |||
it inherits all the same pitfalls and uses a complicated JSON structure.</t> | <li>iCalendar's definition of recurrence rules is ambiguous and has re | |||
sulted in differing interpretations, even between experienced calendar developer | ||||
<t>As a consequence, since the standardization of jCal, the majority of | s.</li> | |||
implementations and service providers either kept using iCalendar, or came up wi | <li>The iCalendar format itself causes interoperability issues due to | |||
th their own proprietary JSON representations, which are incompatible with each | misuse of CRLF-terminated strings, line continuations, and subtle differences am | |||
other and often suffer from common pitfalls, such as storing event start times i | ong iCalendar parsers.</li> | |||
n UTC (which become incorrect if the timezone's rules change in the future). JSC | </ul> | |||
alendar meets the demand for JSON-formatted calendar data that is free of such k | <t>In recent years, many new products and services have appeared that wi | |||
nown problems and provides a standard representation as an alternative to the pr | sh to use a JSON representation of calendar data within their APIs. The JSON for | |||
oprietary formats.</t> | mat for iCalendar data, <xref target="RFC7265" format="default">jCal</xref>, is | |||
a direct mapping between iCalendar and JSON. In its effort to represent full iCa | ||||
lendar semantics, it inherits all the same pitfalls and uses a complicated JSON | ||||
structure.</t> | ||||
<t>As a consequence, since the standardization of jCal, the majority of | ||||
implementations and service providers either kept using iCalendar or came up wit | ||||
h their own proprietary JSON representations, which are incompatible with each o | ||||
ther and often suffer from common pitfalls, such as storing event start times in | ||||
UTC (which become incorrect if the time zone's rules change in the future). JSC | ||||
alendar meets the demand for JSON-formatted calendar data that is free of such k | ||||
nown problems and provides a standard representation as an alternative to the pr | ||||
oprietary formats.</t> | ||||
</section> | </section> | |||
<section anchor="notational-conventions" numbered="true" toc="default"> | ||||
<section anchor="notational-conventions" title="Notational Conventions"> | <name>Notational Conventions</name> | |||
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", " | <t> | |||
SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" i | The key words "<bcp14>MUST</bcp14>", "<bcp14>MUST NOT</bcp14>", "<bcp14>REQU | |||
n this document are to be interpreted as described in BCP 14 <xref target="RFC21 | IRED</bcp14>", "<bcp14>SHALL</bcp14>", "<bcp14>SHALL | |||
19" /> <xref target="RFC8174" /> when, and only when, they appear in all capital | NOT</bcp14>", "<bcp14>SHOULD</bcp14>", "<bcp14>SHOULD NOT</bcp14>", "<bcp14> | |||
s, as shown here.</t> | RECOMMENDED</bcp14>", "<bcp14>NOT RECOMMENDED</bcp14>", | |||
"<bcp14>MAY</bcp14>", and "<bcp14>OPTIONAL</bcp14>" in this document are to | ||||
<t>The underlying format used for this specification is JSON. Consequent | be interpreted as | |||
ly, the terms "object" and "array" as well as the four primitive types (strings, | described in BCP 14 <xref target="RFC2119"/> <xref target="RFC8174"/> | |||
numbers, booleans, and null) are to be interpreted as described in Section 1 of | when, and only when, they appear in all capitals, as shown here. | |||
<xref target="RFC8259" />.</t> | </t> | |||
<t>The underlying format used for this specification is JSON. Consequent | ||||
<t>Some examples in this document contain "partial" JSON documents used | ly, the terms "object" and "array" as well as the four primitive types (strings, | |||
for illustrative purposes. In these examples, three periods "..." are used to in | numbers, booleans, and null) are to be interpreted as described in <xref target | |||
dicate a portion of the document that has been removed for compactness.</t> | ="RFC8259" sectionFormat="of" section="1" />.</t> | |||
<t>Some examples in this document contain "partial" JSON documents used | ||||
for illustrative purposes. In these examples, an ellipsis "..." is used to indic | ||||
ate a portion of the document that has been removed for compactness.</t> | ||||
</section> | </section> | |||
<section anchor="type-signatures" numbered="true" toc="default"> | ||||
<section anchor="type-signatures" title="Type Signatures"> | <name>Type Signatures</name> | |||
<t>Type signatures are given for all JSON values in this document. The f | <t>Type signatures are given for all JSON values in this document. The f | |||
ollowing conventions are used:</t> | ollowing conventions are | |||
used:</t> | ||||
<t><list style="symbols"> | <dl newline="false"> | |||
<t><spanx style="verb">*</spanx> - The type is undefined (the value co | <dt><tt>*</tt>:</dt> | |||
uld be any type, although permitted values may be constrained by the context of | <dd>The type is undefined (the value could be any type, although perm | |||
this value).</t> | itted values may be constrained | |||
<t><spanx style="verb">String</spanx> - The JSON string type.</t> | by the context of this value).</dd> | |||
<t><spanx style="verb">Number</spanx> - The JSON number type.</t> | <dt><tt>String</tt>:</dt> | |||
<t><spanx style="verb">Boolean</spanx> - The JSON boolean type.</t> | <dd>This is the JSON string type.</dd> | |||
<t><spanx style="verb">A[B]</spanx> - A JSON object where the keys are | <dt><tt>Number</tt>:</dt> | |||
all of type <spanx style="verb">A</spanx>, and the values are all of type <span | <dd>This is the JSON number type.</dd> | |||
x style="verb">B</spanx>.</t> | <dt><tt>Boolean</tt>:</dt> | |||
<t><spanx style="verb">A[]</spanx> - An array of values of type | <dd>This is the JSON boolean type.</dd> | |||
<spanx style="verb">A</spanx>.</t> | <dt><tt>A[B]</tt>:</dt> | |||
<t><spanx style="verb">A|B</spanx> - The value is either of type | <dd>The keys are all of type <tt>A</tt> and the values are all of typ | |||
<spanx style="verb">A</spanx> or of type | e | |||
<spanx style="verb">B</spanx>.</t> | <tt>B</tt> for a JSON object.</dd> | |||
</list></t> | <dt><tt>A[]</tt>:</dt> | |||
<dd>There is an array of values of type <tt>A</tt></dd> | ||||
<t>Other types may also be given, with their representations defined els | <dt><tt>A|B</tt>:</dt> | |||
ewhere in this document.</t> | <dd>The value is either of type <tt>A</tt> or of type <tt>B</tt>.</dd | |||
> | ||||
</dl> | ||||
<t>Other types may also be given; their representations are defined else | ||||
where in this document.</t> | ||||
</section> | </section> | |||
<section anchor="data-types" numbered="true" toc="default"> | ||||
<section anchor="data-types" title="Data Types"> | <name>Data Types</name> | |||
<t>In addition to the standard JSON data types, the following data types are used in this specification:</t> | <t>In addition to the standard JSON data types, the following data types are used in this specification:</t> | |||
<section anchor="type-Id" numbered="true" toc="default"> | ||||
<section anchor="type-Id" title="Id"> | <name>Id</name> | |||
<t>Where <spanx style="verb">Id</spanx> is given as a data type, it me | <t>Where <tt>Id</tt> is given as a data type, it means a <tt>String</t | |||
ans a <spanx style="verb">String</spanx> of at least 1 and a maximum of 255 octe | t> of at least 1 and a maximum of 255 octets in size, and it <bcp14>MUST</bcp14> | |||
ts in size, and it MUST only contain characters from the "URL and Filename Safe" | only contain characters from the "URL and Filename Safe" base64url alphabet, as | |||
base64url alphabet, as defined in Section 5 of <xref target="RFC4648" />, exclu | defined in <xref target="RFC4648" sectionFormat="of" section="5"/>, excluding t | |||
ding the pad character (<spanx style="verb">=</spanx>). This means the allowed c | he pad character (<tt>=</tt>). This means the allowed characters are the ASCII a | |||
haracters are the ASCII alphanumeric characters (<spanx style="verb">A-Za-z0-9</ | lphanumeric characters (<tt>A-Za-z0-9</tt>), hyphen (<tt>-</tt>), and underscore | |||
spanx>), hyphen (<spanx style="verb">-</spanx>), and underscore (<spanx style="v | (<tt>_</tt>).</t> | |||
erb">_</spanx>).</t> | <t>In many places in JSCalendar, a JSON map is used where the map keys | |||
are of type Id and the map values are all the same type of object. This constru | ||||
<t>In many places in JSCalendar a JSON map is used where the map keys | ction represents an unordered set of objects, with the added advantage that each | |||
are of type Id and the map values are all the same type of object. This construc | entry has a name (the corresponding map key). This allows for more concise patc | |||
tion represents an unordered set of objects, with the added advantage that each | hing of objects, and, when applicable, for the objects in question to be referen | |||
entry has a name (the corresponding map key). This allows for more concise patch | ced from other objects within the JSCalendar object.</t> | |||
ing of objects, and, when applicable, for the objects in question to be referenc | <t>Unless otherwise specified for a particular property, there are no | |||
ed from other objects within the JSCalendar object.</t> | uniqueness constraints on an Id value (other than, of course, the requirement th | |||
at you cannot have two values with the same key within a single JSON map). For e | ||||
<t>Unless otherwise specified for a particular property, there are no | xample, two Event objects might use the same Ids in their respective <tt>links</ | |||
uniqueness constraints on an Id value (other than, of course, the requirement th | tt> properties or, within the same Event object, the same Id could appear in the | |||
at you cannot have two values with the same key within a single JSON map). For e | <tt>participants</tt> and <tt>alerts</tt> properties. These situations do not i | |||
xample, two JSEvent objects might use the same Ids in their respective <spanx st | mply any semantic connections among the objects.</t> | |||
yle="verb">links</spanx> properties. Or within the same JSEvent object the same | ||||
Id could appear in the <spanx style="verb">participants</spanx> and <spanx style | ||||
="verb">alerts</spanx> properties. These situations do not imply any semantic co | ||||
nnections among the objects. <vspace blankLines="1" /> Nevertheless, a UUID <xre | ||||
f target="RFC4122" /> is typically a good choice.</t> | ||||
</section> | </section> | |||
<section anchor="type-Int" numbered="true" toc="default"> | ||||
<section anchor="type-Int" title="Int"> | <name>Int</name> | |||
<t>Where <spanx style="verb">Int</spanx> is given as a data type, it m | <t>Where <tt>Int</tt> is given as a data type, it means an integer in | |||
eans an integer in the range -2^53+1 <= value <= 2^53-1, the safe range fo | the range -2<sup>53</sup>+1 <= value <= 2<sup>53</sup>-1, the safe range f | |||
r integers stored in a floating-point double, represented as a JSON <spanx style | or integers stored in a floating-point double, represented as a JSON <tt>Number< | |||
="verb">Number</spanx>.</t> | /tt>.</t> | |||
</section> | </section> | |||
<section anchor="type-UnsignedInt" numbered="true" toc="default"> | ||||
<section anchor="type-UnsignedInt" title="UnsignedInt"> | <name>UnsignedInt</name> | |||
<t>Where <spanx style="verb">UnsignedInt</spanx> is given as a data ty | <t>Where <tt>UnsignedInt</tt> is given as a data type, it means an int | |||
pe, it means an integer in the range 0 <= value <= 2^53-1, represented as | eger in the range 0 <= value <= 2<sup>53</sup>-1, represented as a JSON <t | |||
a JSON <spanx style="verb">Number</spanx>.</t> | t>Number</tt>.</t> | |||
</section> | </section> | |||
<section anchor="type-UTCDateTime" numbered="true" toc="default"> | ||||
<section anchor="type-UTCDateTime" title="UTCDateTime"> | <name>UTCDateTime</name> | |||
<t>This is a string in <xref target="RFC3339" /> <spanx style="verb">d | <t>This is a string in the <tt>date-time</tt> <xref target="RFC3339" f | |||
ate-time</spanx> format, with the further restrictions that any letters MUST be | ormat="default"/> format, with | |||
in uppercase, and the time offset MUST be the character <spanx style="verb">Z</s | the | |||
panx>. Fractional second values MUST NOT be included unless non-zero and MUST NO | further restrictions that any letters <bcp14>MUST</bcp14> be in upp | |||
T have trailing zeros, to ensure there is only a single representation for each | ercase, and the time offset | |||
date-time. </t> | <bcp14>MUST</bcp14> be the character <tt>Z</tt>. Fractional secon | |||
d values <bcp14>MUST NOT</bcp14> be | ||||
<t>For example <spanx style="verb">2010-10-10T10:10:10.003Z</spanx> is | included unless non-zero and <bcp14>MUST NOT</bcp14> have trail | |||
conformant, but <spanx style="verb">2010-10-10T10:10:10.000Z</spanx> is invalid | ing zeros, to ensure there is only a | |||
and is correctly encoded as <spanx style="verb">2010-10-10T10:10:10Z</spanx>.</ | single representation for each date-time. </t> | |||
t> | <t>For example, <tt>2010-10-10T10:10:10.003Z</tt> is conformant, but < | |||
tt>2010-10-10T10:10:10.000Z</tt> | ||||
is invalid and is correctly encoded as <tt>2010-10-10T10:10:10Z</tt>. | ||||
</t> | ||||
</section> | </section> | |||
<section anchor="type-LocalDateTime" numbered="true" toc="default"> | ||||
<section anchor="type-LocalDateTime" title="LocalDateTime"> | <name>LocalDateTime</name> | |||
<t>This is a date-time string with no time zone/offset information. It | <t>This is a date-time string with no time zone/offset information. It | |||
is otherwise in the same format as UTCDateTime, including fractional seconds. F | is otherwise in the same | |||
or example <spanx style="verb">2006-01-02T15:04:05</spanx> and <spanx style="ver | format as UTCDateTime, including fractional seconds. For example, <tt | |||
b">2006-01-02T15:04:05.003</spanx> are both valid. The time zone to associate wi | >2006-01-02T15:04:05</tt> and | |||
th the LocalDateTime comes from the <spanx style="verb">timeZone</spanx> propert | <tt>2006-01-02T15:04:05.003</tt> are both valid. The time zone to a | |||
y of the JSCalendar object (see <xref target="prop-timeZone" />). If no time zon | ssociate with the LocalDateTime | |||
e is specified, the LocalDateTime is <spanx style="verb">floating</spanx>. Float | comes from the <tt>timeZone</tt> property of the JSCalendar objec | |||
ing date-times are not tied to any specific time zone. Instead, they occur in ea | t (see <xref target="prop-timeZone" | |||
ch time zone at the given wall-clock time (as opposed to the same instant point | format="default"/>). If no time zone is specified, the LocalDat | |||
in time).</t> | eTime is <tt>floating</tt>. Floating | |||
date-times are not tied to any specific time zone. Instead, the | ||||
<t>A time zone may have a period of discontinuity, for example a chang | y occur in each time zone at the given | |||
e from standard time to daylight-savings time. When converting local date-times | wall-clock time (as opposed to the same instant point in time | |||
that fall in the discontinuity to UTC, the offset before the transition MUST be | ).</t> | |||
used.</t> | <t>A time zone may have a period of discontinuity, for example, a chan | |||
ge from standard time to | ||||
<t>For example, in the America/Los_Angeles time zone, the date-time 20 | daylight savings time. When converting local date-times that fall in | |||
20-11-01T01:30:00 occurs twice: before the DST transition with a UTC offset of - | the discontinuity to UTC, the | |||
07:00, and again after the transition with an offset of -08:00. When converting | offset before the transition <bcp14>MUST</bcp14> be used.</t> | |||
to UTC, we therefore use the offset before the transition (-07:00) and so it bec | <t>For example, in the America/Los_Angeles time zone, the date-time 20 | |||
omes 2020-11-01T08:30:00Z.</t> | 20-11-01T01:30:00 occurs twice: | |||
before the daylight savings time (DST) transition with a UTC offset o | ||||
<t>Similarly, in the Australia/Melbourne time zone, the date-time 2020 | f -07:00 and again after the | |||
-10-04T02:30:00 does not exist: the clocks are moved forward one hour for DST on | transition with an offset of -08:00. When converting to UTC, we the | |||
that day at 02:00. However, such a value may appear during calculations (see du | refore use the offset before the | |||
ration semantics in <xref target="type-Duration" />), or due to a change in time | transition (-07:00), so it becomes 2020-11-01T08:30:00Z.</t> | |||
zone rules (so it was valid when the event was first created). Again, it is int | <t>Similarly, in the Australia/Melbourne time zone, the date-time 2020 | |||
erpreted as though the offset before the transition is in effect (+10:00), there | -10-04T02:30:00 does not exist; | |||
fore when converted to UTC we get 2020-10-03T16:30:00Z.</t> | the clocks are moved forward one hour for DST on that day at 02:00. H | |||
owever, such a value may appear | ||||
during calculations (see duration semantics in <xref target="type-D | ||||
uration" format="default"/>) or | ||||
due to a change in time zone rules (so it was valid when the even | ||||
t was first created). Again, it is | ||||
interpreted as though the offset before the transition is in ef | ||||
fect (+10:00); therefore, when | ||||
converted to UTC, we get 2020-10-03T16:30:00Z.</t> | ||||
</section> | </section> | |||
<section anchor="type-Duration" numbered="true" toc="default"> | ||||
<section anchor="type-Duration" title="Duration"> | <name>Duration</name> | |||
<t>Where Duration is given as a type, it means a length of time repres | <t>Where Duration is given as a type, it means a length of time repres | |||
ented by a subset of ISO8601 duration format, as specified by the following ABNF | ented by a subset of the ISO 8601 duration format, as specified by the following | |||
<xref target="RFC5234" />:</t> | ABNF <xref target="RFC5234" format="default"/>:</t> | |||
<sourcecode name="" type="abnf"><![CDATA[ | ||||
<figure> | dur-secfrac = "." 1*DIGIT | |||
<artwork><![CDATA[ dur-secfrac = "." 1*DIGIT | ||||
dur-second = 1*DIGIT [dur-secfrac] "S" | dur-second = 1*DIGIT [dur-secfrac] "S" | |||
dur-minute = 1*DIGIT "M" [dur-second] | dur-minute = 1*DIGIT "M" [dur-second] | |||
dur-hour = 1*DIGIT "H" [dur-minute] | dur-hour = 1*DIGIT "H" [dur-minute] | |||
dur-time = "T" (dur-hour / dur-minute / dur-second) | dur-time = "T" (dur-hour / dur-minute / dur-second) | |||
dur-day = 1*DIGIT "D" | dur-day = 1*DIGIT "D" | |||
dur-week = 1*DIGIT "W" | dur-week = 1*DIGIT "W" | |||
dur-cal = (dur-week [dur-day] / dur-day) | dur-cal = (dur-week [dur-day] / dur-day) | |||
duration = "P" (dur-cal [dur-time] / dur-time)]]></artwork> | duration = "P" (dur-cal [dur-time] / dur-time) | |||
</figure> | ]]></sourcecode> | |||
<t>In addition, the duration <bcp14>MUST NOT</bcp14> include fractiona | ||||
<t>In addition, the duration MUST NOT include fractional second values | l second values unless the fraction is non-zero. Fractional second values <bcp14 | |||
unless the fraction is non-zero. Fractional second values MUST NOT have trailin | >MUST NOT</bcp14> have trailing zeros to ensure there is only a single represent | |||
g zeros, to ensure there is only a single representation for each duration.</t> | ation for each duration.</t> | |||
<t>A duration specifies an abstract number of weeks, days, hours, minu | ||||
<t>A duration specifies an abstract number of weeks, days, hours, minu | tes, and/or seconds. A duration specified using weeks or days does not always co | |||
tes, and/or seconds. A duration specified using weeks or days does not always co | rrespond to an exact multiple of 24 hours. The number of hours/minutes/seconds m | |||
rrespond to an exact multiple of 24 hours. The number of hours/minutes/seconds m | ay vary if it overlaps a period of discontinuity in the event's time zone, for e | |||
ay vary if it overlaps a period of discontinuity in the event's time zone, for e | xample, a change from standard time to daylight savings time. Leap seconds <bcp1 | |||
xample a change from standard time to daylight-savings time. Leap seconds MUST N | 4>MUST NOT</bcp14> be considered when adding or subtracting a duration to/from a | |||
OT be considered when adding or subtracting a duration to/from a LocalDateTime.< | LocalDateTime.</t> | |||
/t> | ||||
<t>To add a duration to a LocalDateTime: | <t>To add a duration to a LocalDateTime: | |||
<list style="numbers"> | </t> | |||
<t>Add any week or day components of the duration to the date. A w | <ol spacing="normal" type="1"><li>Add any week or day components of th | |||
eek is always the same as 7 days.</t> | e duration to the date. A week is always the same as seven days.</li> | |||
<t>If a time zone applies to the LocalDateTime, convert it to a UT | <li>If a time zone applies to the LocalDateTime, convert it to a UTC | |||
CDateTime following the semantics in <xref target="type-LocalDateTime" />.</t> | DateTime following the semantics in <xref target="type-LocalDateTime" format="de | |||
<t>Add any hour, minute or second components of the duration (in a | fault"/>.</li> | |||
bsolute time).</t> | <li>Add any hour, minute, or second components of the duration (in a | |||
<t>Convert the resulting UTCDateTime back to a LocalDateTime in th | bsolute time).</li> | |||
e time zone that applies.</t> | <li>Convert the resulting UTCDateTime back to a LocalDateTime in the | |||
</list></t> | time zone that applies.</li> | |||
</ol> | ||||
<t>To subtract a duration from a LocalDateTime, the steps apply in rev erse: | <t>To subtract a duration from a LocalDateTime, the steps apply in rev erse: | |||
<list style="numbers"> | </t> | |||
<t>If a time zone applies to the LocalDateTime, convert it to UTC | <ol spacing="normal" type="1"><li>If a time zone applies to the LocalD | |||
following the semantics in <xref target="type-LocalDateTime" />.</t> | ateTime, convert it to UTC following the semantics in <xref target="type-LocalDa | |||
<t>Subtract any hour, minute or second components of the duration | teTime" format="default"/>.</li> | |||
(in absolute time).</t> | <li>Subtract any hour, minute, or second components of the duration | |||
<t>Convert the resulting UTCDateTime back to LocalDateTime in the | (in absolute time).</li> | |||
time zone that applies.</t> | <li>Convert the resulting UTCDateTime back to LocalDateTime in the t | |||
<t>Subtract any week or day components of the duration from the da | ime zone that applies.</li> | |||
te.</t> | <li>Subtract any week or day components of the duration from the dat | |||
<t>If the resulting time does not exist on the date due to a disco | e.</li> | |||
ntinuity in the time zone, use the semantics in <xref target="type-LocalDateTime | <li>If the resulting time does not exist on the date due to a discon | |||
" /> to convert to UTC and back to get a valid LocalDateTime.</t> | tinuity in the time zone, use the semantics in <xref target="type-LocalDateTime" | |||
</list></t> | format="default"/> to convert to UTC and back to get a valid LocalDateTime.</li | |||
> | ||||
<t>These semantics match the iCalendar DURATION value type (<xref targ | </ol> | |||
et="RFC5545" />, Section 3.3.6).</t> | <t>These semantics match the iCalendar DURATION value type (<xref targ | |||
et="RFC5545" sectionFormat="comma" section="3.3.6"/>).</t> | ||||
</section> | </section> | |||
<section anchor="type-SignedDuration" numbered="true" toc="default"> | ||||
<section anchor="type-SignedDuration" title="SignedDuration"> | <name>SignedDuration</name> | |||
<t>A SignedDuration represents a length of time that may be positive o r negative and is typically used to express the offset of a point in time relati ve to an associated time. It is represented as a Duration, optionally preceded b y a sign character. It is specified by the following ABNF:</t> | <t>A SignedDuration represents a length of time that may be positive o r negative and is typically used to express the offset of a point in time relati ve to an associated time. It is represented as a Duration, optionally preceded b y a sign character. It is specified by the following ABNF:</t> | |||
<sourcecode name="" type="abnf"><![CDATA[ | ||||
<figure> | signed-duration = ["+" / "-"] duration | |||
<artwork><![CDATA[ signed-duration = ["+" / "-"] duration]]></art | ]]></sourcecode> | |||
work> | <t>A negative sign indicates a point in time at or before the associat | |||
</figure> | ed time; a positive or no sign | |||
indicates a time at or after the associated time.</t> | ||||
<t>A negative sign indicates a point in time at or before the associat | ||||
ed time, a positive or no sign a time at or after the associated time.</t> | ||||
</section> | </section> | |||
<section anchor="type-timeZoneId" numbered="true" toc="default"> | ||||
<section anchor="type-timeZoneId" title="TimeZoneId"> | <name>TimeZoneId</name> | |||
<t>Where <spanx style="verb">TimeZoneId</spanx> is given as a data typ | <t>Where <tt>TimeZoneId</tt> is given as a data type, it means a <tt>S | |||
e, it means a <spanx style="verb">String</spanx> that is either a time zone name | tring</tt> that is either a | |||
in the IANA Time Zone Database <xref target="TZDB" /> or a custom time zone ide | time zone name in the IANA Time Zone Database <xref target="TZDB" for | |||
ntifier defined in the <spanx style="verb">timeZones</spanx> property (see <xref | mat="default"/> or a custom time | |||
target="prop-timeZones" />).</t> | zone identifier defined in the <tt>timeZones</tt> property (see <xr | |||
ef target="prop-timeZones" | ||||
<t>Where an IANA time zone is specified, the zone rules of the respect | format="default"/>).</t> | |||
ive zone records apply. Custom time zones are interpreted as described in <xref | <t>Where an IANA time zone is specified, the zone rules of the respect | |||
target="prop-timeZones" />.</t> | ive zone records apply. Custom | |||
</section> | time zones are interpreted as described in <xref target="prop-timeZon | |||
es" format="default"/>.</t> | ||||
<section anchor="type-PatchObject" title="PatchObject"> | </section> | |||
<t>A PatchObject is of type <spanx style="verb">String[*]</spanx>, and | <section anchor="type-PatchObject" numbered="true" toc="default"> | |||
represents an unordered set of patches on a JSON object. | <name>PatchObject</name> | |||
Each key is a path represented in a subset of JSON pointer format <xre | <t>A PatchObject is of type <tt>String[*]</tt> and represents an unord | |||
f target="RFC6901" />. The paths have an implicit leading <spanx style="verb">/< | ered set of patches on a JSON | |||
/spanx>, so each key is prefixed with <spanx style="verb">/</spanx> before apply | object. Each key is a path represented in a subset of the JSON Pointe | |||
ing the JSON pointer evaluation algorithm.</t> | r format <xref target="RFC6901" | |||
format="default"/>. The paths have an implicit leading <tt>/</tt>, | ||||
so each key is prefixed with | ||||
<tt>/</tt> before applying the JSON Pointer evaluation algorithm.</ | ||||
t> | ||||
<t>A patch within a PatchObject is only valid if all of the following conditions apply:</t> | <t>A patch within a PatchObject is only valid if all of the following conditions apply:</t> | |||
<ol spacing="normal" type="1"> | ||||
<t><list style="numbers"> | <li>The pointer <bcp14>MUST NOT</bcp14> reference inside an array | |||
<t>The pointer MUST NOT reference inside an array (i.e., you MUST NO | (i.e., you <bcp14>MUST | |||
T insert/delete from an array; the array MUST be replaced in its entirety instea | NOT</bcp14> insert/delete from an array; the array <bcp14>MUS | |||
d).</t> | T</bcp14> be replaced in its entirety | |||
<t>All parts prior to the last (i.e., the value after the final slas | instead).</li> | |||
h) MUST already exist on the object being patched.</t> | <li>All parts prior to the last (i.e., the value after the final sla | |||
<t>There MUST NOT be two patches in the PatchObject where the pointe | sh) <bcp14>MUST</bcp14> already | |||
r of one is the prefix of the pointer of the other, e.g., <spanx style="verb">al | exist on the object being patched.</li> | |||
erts/1/offset</spanx> and <spanx style="verb">alerts</spanx>.</t> | <li>There <bcp14>MUST NOT</bcp14> be two patches in the PatchObject | |||
<t>The value for the patch MUST be valid for the property being set | where the pointer of one is the | |||
(of the correct type and obeying any other applicable restrictions), or if null | prefix of the pointer of the other, e.g., <tt>alerts/1/offset</tt | |||
the property MUST be optional.</t> | > and <tt>alerts</tt>.</li> | |||
</list></t> | <li>The value for the patch <bcp14>MUST</bcp14> be valid for the pro | |||
perty being set (of the correct | ||||
<t>The value associated with each pointer determines how to apply that | type and obeying any other applicable restrictions), or, if null, | |||
patch: | the property <bcp14>MUST</bcp14> be | |||
<list style="symbols"> | optional.</li> | |||
<t>If null, remove the property from the patched object. If the ke | </ol> | |||
y is not present in the parent, this a no-op.</t> | <t>The value associated with each pointer determines how to apply that | |||
<t>Anything else: The value to set for this property (this may be | patch:</t> | |||
a replacement or addition to the object being patched).</t> | <ul spacing="normal"> | |||
</list> | <li>If null, remove the property from the patched object. If the key | |||
</t> | is not present in the parent, this a no-op.</li> | |||
<li>If non-null, set the value given as the value for this property | ||||
<t>A PatchObject does not define its own <spanx style="verb">@type</sp | (this may be a replacement or addition to the object being patched). | |||
anx> property (see <xref target="prop-type" />). A <spanx style="verb">@type</sp | </li> | |||
anx> property in a patch MUST be handled as any other patched property value.</t | </ul> | |||
> | <t>A PatchObject does not define its own <tt>@type</tt> property (see | |||
<xref target="prop-type" | ||||
<t>Implementations MUST reject in its entirety a PatchObject if any of | format="default"/>). An <tt>@type</tt> property in a patch <bcp14>MUS | |||
its patches is invalid. Implementations MUST NOT apply partial patches.</t> | T</bcp14> be handled as any other | |||
patched property value.</t> | ||||
<t>The PatchObject format is used to significantly reduce file size an | <t>Implementations <bcp14>MUST</bcp14> reject a PatchObject in its ent | |||
d duplicated content when specifying variations to a common object, such as with | irety if any of its patches are | |||
recurring events or when translating the data into multiple languages. It can a | invalid. Implementations <bcp14>MUST NOT</bcp14> apply partial patch | |||
lso better preserve semantic intent if only the properties that should differ be | es.</t> | |||
tween the two objects are patched. For example, if one person is not going to a | <t>The PatchObject format is used to significantly reduce file size an | |||
particular instance of a regularly scheduled event, in iCalendar you would have | d duplicated content when | |||
to duplicate the entire event in the override. In JSCalendar this is a small pat | specifying variations to a common object, such as with recurring even | |||
ch to show the difference. As only this property is patched, if the location of | ts or when translating the data | |||
the event is changed, the occurrence will automatically still inherit this.</t> | into multiple languages. It can also better preserve semantic inten | |||
t if only the properties that | ||||
should differ between the two objects are patched. For example, i | ||||
f one person is not going to a | ||||
particular instance of a regularly scheduled event, in iCalenda | ||||
r, you would have to duplicate the | ||||
entire event in the override. In JSCalendar, this is a small | ||||
patch to show the difference. As only | ||||
this property is patched, if the location of the event is c | ||||
hanged, the occurrence will automatically | ||||
still inherit this.</t> | ||||
</section> | </section> | |||
<section anchor="type-Relation" numbered="true" toc="default"> | ||||
<section anchor="type-Relation" title="Relation"> | <name>Relation</name> | |||
<t>A Relation object defines the relation to other objects, using a po | <t>A Relation object defines the relation to other objects, using a po | |||
ssibly empty set of relation types. The object that defines this relation is the | ssibly empty set of relation | |||
linking object, while the other object is the linked object. A Relation object | types. The object that defines this relation is the linking object, w | |||
has the following properties:</t> | hile the other object is the | |||
<t><list style="symbols"> | linked object. A Relation object has the following properties:</t> | |||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | <dl newline="true"> | |||
<vspace blankLines="1" /> | <dt>@type: <tt>String</tt> (mandatory)</dt> | |||
Specifies the type of this object. This MUST be <spanx style="ver | <dd>This specifies the type of this object. This <bcp14>MUST</bcp1 | |||
b">Relation</spanx>. | 4> be <tt>Relation</tt>.</dd> | |||
</t> | <dt>relation: <tt>String[Boolean]</tt> (optional, default: empty O | |||
<t>relation: <spanx style="verb">String[Boolean]</spanx> (optional, | bject)</dt> | |||
default: empty Object) | <dd><t>This describes how the linked object is related to the link | |||
<vspace blankLines="1" /> | ing object. The relation is defined | |||
Describes how the linked object is related to the linking object. Th | as a set of relation types. If empty, the relationship betwee | |||
e relation is defined as a set of relation types. If empty, the relationship bet | n the two objects is unspecified.</t> | |||
ween the two objects is unspecified. | <t>Keys in the set <bcp14>MUST</bcp14> be one of the fo | |||
<vspace blankLines="1" /> | llowing values, specified in the | |||
Keys in the set MUST be one of the following values, or specified in | property definition where the Relation object is | |||
the property definition where the Relation object is used, or a value registere | used, a value registered in the IANA | |||
d in the IANA JSCalendar Enum Values registry, or a vendor-specific value (see < | "JSCalendar Enum Values" registry | |||
xref target="custom-properties" />): | , or a vendor-specific value (see <xref target="custom-properties" | |||
<list style="symbols"> | format="default"/>):</t> | |||
<t><spanx style="verb">first</spanx>: The linked object is the fir | <dl newline="false"> | |||
st in a series the linking object is part of.</t> | <dt><tt>first</tt>:</dt> | |||
<t><spanx style="verb">next</spanx>: The linked object is the next | <dd>The linked object is the first in a series the linking object | |||
in a series the linking object is part of.</t> | is part of.</dd> | |||
<t><spanx style="verb">child</spanx>: The linked object is a subpa | <dt><tt>next</tt>:</dt> | |||
rt of the linking object.</t> | <dd>The linked object is next in a series the linking object is p | |||
<t><spanx style="verb">parent</spanx>: The linking object is a sub | art of.</dd> | |||
part of the linked object.</t> | <dt><tt>child</tt>:</dt> | |||
</list> | <dd>The linked object is a subpart of the linking object.</dd> | |||
The value for each key in the map MUST be true.</t> | <dt><tt>parent</tt>:</dt> | |||
</list></t> | <dd>The linking object is a subpart of the linked object.</dd> | |||
</dl> | ||||
<t> | ||||
The value for each key in the map <bcp14>MUST</bcp14> be true.</t> | ||||
</dd></dl> | ||||
</section> | </section> | |||
<section anchor="type-Link" title="Link"> | <section anchor="type-Link" numbered="true" toc="default"> | |||
<t>A Link object represents an external resource associated with the l | <name>Link</name> | |||
inking object. It has the following properties:</t> | <t>A Link object represents an external resource associated with the l | |||
inking object. It has the | ||||
<t><list style="symbols"> | following properties:</t> | |||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | <dl newline="true"> | |||
<vspace blankLines="1" /> | <dt>@type: <tt>String</tt> (mandatory)</dt> | |||
Specifies the type of this object. This MUST be <spanx style="verb"> | <dd>This specifies the type of this object. This <bcp14>MUST</bcp1 | |||
Link</spanx>.</t> | 4> be <tt>Link</tt>.</dd> | |||
<t>href: <spanx style="verb">String</spanx> (mandatory) | <dt>href: <tt>String</tt> (mandatory)</dt> | |||
<vspace blankLines="1" /> | <dd><t>This is a URI <xref target="RFC3986" format="default"/> fro | |||
A URI <xref target="RFC3986" /> from which the resource may be fetch | m which the resource may be | |||
ed. | fetched.</t> | |||
<vspace blankLines="1" /> | <t>This <bcp14>MAY</bcp14> be a <tt>data:</tt> URL <xref target="R | |||
This MAY be a <spanx style="verb">data:</spanx> URL <xref target="RF | FC2397" format="default"/>, but | |||
C2397" />, but it is recommended that the file be hosted on a server to avoid em | it is recommended that the file be hosted on a server to avoi | |||
bedding arbitrarily large data in JSCalendar object instances.</t> | d embedding arbitrarily large data | |||
in JSCalendar object instances.</t></dd> | ||||
<t>cid: <spanx style="verb">String</spanx> (optional) | <dt>cid: <tt>String</tt> (optional) | |||
<vspace blankLines="1" /> | </dt> | |||
This MUST be a valid <spanx style="verb">content-id</spanx> value ac | <dd><t>This <bcp14>MUST</bcp14> be a valid <tt>content-id</tt> val | |||
cording to the definition of Section 2 in <xref target="RFC2392" />. The value M | ue according to the definition | |||
UST be unique within this Link object but has no meaning beyond that. It MAY be | of <xref target="RFC2392" sectionFormat="of" section="2"/>. T | |||
different from the link id for this Link object.</t> | he value <bcp14>MUST</bcp14> be | |||
unique within this Link object but has no meaning beyon | ||||
<t>contentType: <spanx style="verb">String</spanx> (optional) | d that. It <bcp14>MAY</bcp14> be different | |||
<vspace blankLines="1" /> | from the link id for this Link object.</t></dd> | |||
The media type <xref target="RFC6838" /> of the resource, if known.< | <dt>contentType: <tt>String</tt> (optional)</dt> | |||
/t> | <dd>This is the media type <xref target="RFC6838" format="default" | |||
/> of the resource, if | ||||
<t>size: <spanx style="verb">UnsignedInt</spanx> (optional) | known.</dd> | |||
<vspace blankLines="1" /> | <dt>size: <tt>UnsignedInt</tt> (optional)</dt> | |||
The size, in octets, of the resource when fully decoded (i.e., the n | <dd>This is the size, in octets, of the resource when fully decode | |||
umber of octets in the file the user would download), if known. Note that this i | d (i.e., the number of octets | |||
s an informational estimate, and implementations must be prepared to handle the | in the | |||
actual size being quite different when the resource is fetched.</t> | file the user would download), if known. Note that this | |||
is an informational estimate, and | ||||
<t>rel: <spanx style="verb">String</spanx> (optional) | implementations must be prepared to handle the ac | |||
<vspace blankLines="1" /> | tual size being quite different when the | |||
Identifies the relation of the linked resource to the object. If set | resource is fetched.</dd> | |||
, the value MUST be a relation type from the IANA registry <xref target="LINKREL | <dt>rel: <tt>String</tt> (optional)</dt> | |||
S" />, as established in <xref target="RFC8288" />.</t> | <dd>This identifies the relation of the linked resource to the obj | |||
ect. If set, the value | ||||
<t>display: <spanx style="verb">String</spanx> (optional) | <bcp14>MUST</bcp14> be a relation type from the IANA "Li | |||
<vspace blankLines="1" /> | nk Relations" registry <xref target="LINKRELS" | |||
Describes the intended purpose of a link to an image. If set, the <s | format="default"/>, as established in <xref target="RFC | |||
panx style="verb">rel</spanx> property MUST be set to <spanx style="verb">icon</ | 8288" format="default"/>.</dd> | |||
spanx>. The value MUST be one of the following values, another value registered | <dt>display: <tt>String</tt> (optional)</dt> | |||
in the IANA JSCalendar Enum Values registry, or a vendor-specific value (see <xr | <dd><t>This describes the intended purpose of a link to an image. | |||
ef target="custom-properties" />): | If set, the <tt>rel</tt> | |||
property <bcp14>MUST</bcp14> be set to <tt>icon</tt>. The val | ||||
<list style="symbols"> | ue <bcp14>MUST</bcp14> be one of the | |||
<t><spanx style="verb">badge</spanx>: an image meant to be display | following values, another value registered in the IANA | |||
ed alongside the title of the object.</t> | "JSCalendar Enum Values" registry, or a | |||
vendor-specific value (see <xref target="custom-p | ||||
<t><spanx style="verb">graphic</spanx>: a full image replacement f | roperties" format="default"/>):</t> | |||
or the object itself.</t> | <dl newline="false"> | |||
<dt><tt>badge</tt>:</dt> | ||||
<t><spanx style="verb">fullsize</spanx>: an image that is used to | <dd>an image meant to be displayed alongside the title of the obj | |||
enhance the object.</t> | ect</dd> | |||
<dt><tt>graphic</tt>:</dt> | ||||
<t><spanx style="verb">thumbnail</spanx>: a smaller variant of <sp | <dd>a full image replacement for the object itself</dd> | |||
anx style="verb">fullsize</spanx> to be used when space for the image is constra | <dt><tt>fullsize</tt>:</dt> | |||
ined.</t> | <dd>an image that is used to enhance the object</dd> | |||
</list></t> | <dt><tt>thumbnail</tt>:</dt> | |||
<dd>a smaller variant of <tt>fullsize</tt> to be used when space | ||||
<t>title: <spanx style="verb">String</spanx> (optional) | for the image is | |||
<vspace blankLines="1" /> | constrained</dd> | |||
A human-readable plain-text description of the resource.</t> | </dl> | |||
</list></t> | </dd> | |||
<dt>title: <tt>String</tt> (optional)</dt> | ||||
<dd>This is a human-readable, plain-text description of the resour | ||||
ce.</dd> | ||||
</dl> | ||||
</section> | </section> | |||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="jscalendar-objects" numbered="true" toc="default"> | ||||
<section anchor="jscalendar-objects" title="JSCalendar Objects"> | <name>JSCalendar Objects</name> | |||
<t>This section describes the calendar object types specified by JSCalenda r.</t> | <t>This section describes the calendar object types specified by JSCalenda r.</t> | |||
<section anchor="jsevent" numbered="true" toc="default"> | ||||
<section anchor="jsevent" title="JSEvent"> | <name>Event</name> | |||
<t>Media type: <spanx style="verb">application/jscalendar+json;type=jsev | <t>Media type: <tt>application/jscalendar+json;type=event</tt></t> | |||
ent</spanx></t> | <t>An Event represents a scheduled amount of time on a calendar, typical | |||
ly a meeting, appointment, | ||||
<t>A JSEvent represents a scheduled amount of time on a calendar, typica | reminder, or anniversary. It is required to start at a certain point in t | |||
lly a meeting, appointment, reminder or anniversary. It is required to start at | ime and typically has a | |||
a certain point in time and typically has a non-zero duration. Multiple particip | non-zero duration. Multiple participants may partake in the event at mult | |||
ants may partake in the event at multiple locations.</t> | iple locations.</t> | |||
<t>The <xref target="prop-type" format="default">@type</xref> property v | ||||
<t>The <xref target="prop-type">@type</xref> property value MUST be <spa | alue <bcp14>MUST</bcp14> be | |||
nx style="verb">jsevent</spanx>.</t> | <tt>Event</tt>.</t> | |||
</section> | </section> | |||
<section anchor="jstask" numbered="true" toc="default"> | ||||
<section anchor="jstask" title="JSTask"> | <name>Task</name> | |||
<t>Media type: <spanx style="verb">application/jscalendar+json;type=jsta | <t>Media type: <tt>application/jscalendar+json;type=task</tt></t> | |||
sk</spanx></t> | <t>A Task represents an action item, assignment, to-do item, or work ite | |||
m. It may start and be due at | ||||
<t>A JSTask represents an action-item, assignment, to-do or work item. I | certain points in time, take some estimated time to complete, and recur, | |||
t may start and be due at certain points in time, may take some estimated time t | none of which is | |||
o complete, and may recur, none of which is required.</t> | required.</t> | |||
<t>The <xref target="prop-type" format="default">@type</xref> property v | ||||
<t>The <xref target="prop-type">@type</xref> property value MUST be <spa | alue <bcp14>MUST</bcp14> be | |||
nx style="verb">jstask</spanx>.</t> | <tt>Task</tt>.</t> | |||
</section> | </section> | |||
<section anchor="jsgroup" numbered="true" toc="default"> | ||||
<section anchor="jsgroup" title="JSGroup"> | <name>Group</name> | |||
<t>Media type: <spanx style="verb">application/jscalendar+json;type=jsgr | <t>Media type: <tt>application/jscalendar+json;type=group</tt></t> | |||
oup</spanx></t> | <t>A Group is a collection of <xref target="jsevent" format="default">Ev | |||
ent</xref> and/or <xref | ||||
<t>A JSGroup is a collection of <xref target="jsevent">JSEvent</xref> an | target="jstask" format="default">Task</xref> objects. Typically, objects | |||
d/or <xref target="jstask">JSTask</xref> objects. Typically, objects are grouped | are grouped by topic (e.g., | |||
by topic (e.g., by keywords) or calendar membership.</t> | by keywords) or calendar membership.</t> | |||
<t>The <xref target="prop-type" format="default">@type</xref> property v | ||||
<t>The <xref target="prop-type">@type</xref> property value MUST be <spa | alue <bcp14>MUST</bcp14> be | |||
nx style="verb">jsgroup</spanx>.</t> | <tt>Group</tt>.</t> | |||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="structure-of-jscalendar-objects" numbered="true" toc="defau | ||||
<section anchor="structure-of-jscalendar-objects" title="Structure of JSCale | lt"> | |||
ndar Objects"> | <name>Structure of JSCalendar Objects</name> | |||
<t>A JSCalendar object is a JSON object <xref target="RFC8259" />, which | <t>A JSCalendar object is a JSON object <xref target="RFC8259" format="def | |||
MUST be valid I-JSON (a stricter subset of JSON) <xref target="RFC7493" />. Pro | ault"/>, which | |||
perty names and values are case-sensitive.</t> | <bcp14>MUST</bcp14> be valid I-JSON (a stricter subset of JSON) <xref targ | |||
et="RFC7493" | ||||
<t>The object has a collection of properties, as specified in the followin | format="default"/>. Property names and values are case sensitive.</t> | |||
g sections. Properties are specified as being either mandatory or optional. Opti | <t>The object has a collection of properties, as specified in the followin | |||
onal properties may have a default value, if explicitly specified in the propert | g sections. Properties are | |||
y definition.</t> | specified as being either mandatory or optional. Optional properties may h | |||
ave a default value if | ||||
<section anchor="objecttype" title="Object Type"> | explicitly specified in the property definition.</t> | |||
<t>JSCalendar objects MUST name their type in the <spanx style="verb"> | <section anchor="objecttype" numbered="true" toc="default"> | |||
@type</spanx> property, if not explicitly specified otherwise for the respective | <name>Object Type</name> | |||
object type. A notable exception to this rule is the <xref target="type-PatchOb | <t>JSCalendar objects <bcp14>MUST</bcp14> name their type in the <tt>@ty | |||
ject">PatchObject</xref>.</t> | pe</tt> property if not | |||
explicitly specified otherwise for the respective object type. A notable | ||||
exception to this rule is the | ||||
<xref target="type-PatchObject" format="default">PatchObject</xref>.</t> | ||||
</section> | </section> | |||
<section anchor="normalization" numbered="true" toc="default"> | ||||
<section anchor="normalization" title="Normalization and Equivalence"> | <name>Normalization and Equivalence</name> | |||
<t>JSCalendar aims to provide unambiguous definitions for value types an | <t>JSCalendar aims to provide unambiguous definitions for value types an | |||
d properties, but does not define a general normalization or equivalence method | d properties but does not | |||
for JSCalendar objects and types. This is because the notion of equivalence migh | define a general normalization or equivalence method for JSCalendar objec | |||
t range from byte-level equivalence to semantic equivalence, depending on the re | ts and types. This is because | |||
spective use case. | the notion of equivalence might range from byte-level equivalence to sema | |||
ntic equivalence, depending on | ||||
<vspace blankLines="1" /> | the respective use case. Normalization of JSCalendar objects is hindered | |||
because of the following | ||||
Normalization of JSCalendar objects is hindered because of the following | reasons:</t> | |||
reasons: | <ul spacing="normal"> | |||
<li>Custom JSCalendar properties may contain arbitrary JSON values, in | ||||
<list style="symbols"> | cluding arrays. However, | |||
<t>Custom JSCalendar properties may contain arbitrary JSON values, inc | equivalence of arrays might or might not depend on the order of eleme | |||
luding arrays. However, equivalence of arrays might or might not depend on the o | nts, depending on the respective | |||
rder of elements, depending on the respective property definition.</t> | property definition.</li> | |||
<t>Several JSCalendar property values are defined as URIs and media ty | <li>Several JSCalendar property values are defined as URIs and media t | |||
pes, but normalization of these types is inherently protocol- and scheme-specifi | ypes, but normalization of | |||
c, depending on the use-case of the equivalence definition (see Section 6 of <xr | these types is inherently protocol and scheme specific, depending on | |||
ef target="RFC3986" />).</t> | the use case of the equivalence | |||
</list> | definition (see <xref target="RFC3986" sectionFormat="of" section=" | |||
6" />).</li> | ||||
Considering this, the definition of equivalence and normalization is lef | </ul> | |||
t to client and server implementations and to be negotiated by a calendar exchan | <t>Considering this, the definition of equivalence and normalization is | |||
ge protocol or defined elsewhere.</t> | left to client and server | |||
implementations and to be negotiated by a calendar exchange protocol or d | ||||
efined elsewhere.</t> | ||||
</section> | </section> | |||
<section anchor="custom-properties" numbered="true" toc="default"> | ||||
<section anchor="custom-properties" title="Vendor-specific Property Extens | <name>Vendor-Specific Property Extensions, Values, and Types</name> | |||
ions, Values and Types"> | <t>Vendors <bcp14>MAY</bcp14> add additional properties to the calendar | |||
<t>Vendors MAY add additional properties to the calendar object to suppo | object to support their custom features. To avoid conflict, the names of these p | |||
rt their custom features. To avoid conflict, the names of these properties MUST | roperties <bcp14>MUST</bcp14> be prefixed by a domain name controlled by the ven | |||
be prefixed by a domain name controlled by the vendor followed by a colon, e.g., | dor followed by a colon, e.g., <tt>example.com:customprop</tt>. If the value is | |||
<spanx style="verb">example.com:customprop</spanx>. If the value is a new JSCal | a new JSCalendar object, it either <bcp14>MUST</bcp14> include an <tt>@type</tt> | |||
endar object, it either MUST include a <spanx style="verb">@type</spanx> propert | property, or it <bcp14>MUST</bcp14> explicitly be specified to not require a ty | |||
y or it MUST explicitly be specified to not require a type designator. The type | pe designator. The type name <bcp14>MUST</bcp14> be prefixed with a domain name | |||
name MUST be prefixed with a domain name controlled by the vendor.</t> | controlled by the vendor.</t> | |||
<t>Some JSCalendar properties allow vendor-specific value extensions. Su | ||||
<t>Some JSCalendar properties allow vendor-specific value extensions. Su | ch vendor-specific values <bcp14>MUST</bcp14> be prefixed by a domain name contr | |||
ch vendor-specific values MUST be prefixed by a domain name controlled by the ve | olled by the vendor followed by a colon, e.g., <tt>example.com:customrel</tt>.</ | |||
ndor followed by a colon, e.g., <spanx style="verb">example.com:customrel</spanx | t> | |||
>.</t> | ||||
<t>Vendors are strongly encouraged to register any new property values o r extensions that are useful to other systems as well, rather than use a vendor- specific prefix.</t> | <t>Vendors are strongly encouraged to register any new property values o r extensions that are useful to other systems as well, rather than use a vendor- specific prefix.</t> | |||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="jscalendar-props" numbered="true" toc="default"> | ||||
<section anchor="jscalendar-props" title="Common JSCalendar Properties"> | <name>Common JSCalendar Properties</name> | |||
<t>This section describes the properties that are common to the various JS | <t>This section describes the properties that are common to the various JS | |||
Calendar object types. Specific JSCalendar object types may only support a subse | Calendar object types. Specific JSCalendar object types may only support a subse | |||
t of these properties. The object type definitions in <xref target="jscalendar-o | t of these properties. The object type definitions in <xref target="jscalendar-o | |||
bject-props" /> describe the set of supported properties per type.</t> | bject-props" format="default"/> describe the set of supported properties per typ | |||
e.</t> | ||||
<section anchor="metadata-properties" title="Metadata Properties"> | <section anchor="metadata-properties" numbered="true" toc="default"> | |||
<section anchor="prop-type" title="@type"> | <name>Metadata Properties</name> | |||
<t>Type: <spanx style="verb">String</spanx> (mandatory).</t> | <section anchor="prop-type" numbered="true" toc="default"> | |||
<t>Specifies the type which this object represents. This MUST be one o | <name>@type</name> | |||
f the following values: | <t>Type: <tt>String</tt> (mandatory)</t> | |||
<list style="symbols"> | <t>This specifies the type that this object represents. The allowed va | |||
<t><spanx style="verb">jsevent</spanx>: a JSCalendar event (<xref | lue differs by object type and is defined in Sections <xref target="jsevent" for | |||
target="jsevent" />).</t> | mat="counter"/>, <xref target="jstask" format="counter"/>, and <xref target="jsg | |||
<t><spanx style="verb">jstask</spanx>: a JSCalendar task (<xref ta | roup" format="counter"/>.</t> | |||
rget="jstask" />).</t> | ||||
<t><spanx style="verb">jsgroup</spanx>: a JSCalendar group (<xref | ||||
target="jsgroup" />).</t> | ||||
</list> | ||||
</t> | ||||
</section> | </section> | |||
<section anchor="prop-uid" numbered="true" toc="default"> | ||||
<section anchor="prop-uid" title="uid"> | <name>uid</name> | |||
<t>Type: <spanx style="verb">String</spanx> (mandatory).</t> | <t>Type: <tt>String</tt> (mandatory)</t> | |||
<t>A globally unique identifier, used to associate the object as the s | <t>This is a globally unique identifier used to associate objects repr | |||
ame across different systems, calendars and views. The value of this property MU | esenting the same event, task, group, or other object across different systems, | |||
ST be unique across all JSCalendar objects, even if they are of different type. | calendars, and views. For recurring events and tasks, the UID is associated with | |||
<xref target="RFC4122" /> describes a range of established algorithms to generat | the base object and therefore is the same for all occurrences; the combination | |||
e universally unique identifiers (UUID). UUID version 4, described in Section 4. | of the UID with a <tt>recurrenceId</tt> identifies a particular instance.</t> | |||
4 of <xref target="RFC4122" />, is RECOMMENDED.</t> | <t>The generator of the identifier <bcp14>MUST</bcp14> guarantee that | |||
the identifier is unique. <xref target="RFC4122" format="default"/> describes a | ||||
<t>For compatibility with <xref target="RFC5545" /> UIDs, implementati | range of established algorithms to generate universally unique identifiers (UUID | |||
ons MUST be able to receive and persist values of at least 255 octets for this p | s). UUID version 4, described in <xref target="RFC4122" sectionFormat="of" secti | |||
roperty, but they MUST NOT truncate values in the middle of a UTF-8 multi-octet | on="4.4"/>, is <bcp14>RECOMMENDED</bcp14>.</t> | |||
sequence.</t> | <t>For compatibility with UIDs <xref target="RFC5545" format="default | |||
"/>, implementations <bcp14>MUST</bcp14> be able to receive and persist values o | ||||
f at least 255 octets for this property, but they <bcp14>MUST NOT</bcp14> trunca | ||||
te values in the middle of a UTF-8 multi-octet sequence.</t> | ||||
</section> | </section> | |||
<section anchor="prop-relatedTo" title="relatedTo"> | <section anchor="prop-relatedTo" numbered="true" toc="default"> | |||
<t>Type: <spanx style="verb">String[Relation]</spanx> (optional).</t> | <name>relatedTo</name> | |||
<t>Type: <tt>String[Relation]</tt> (optional)</t> | ||||
<t>Relates the object to other JSCalendar objects. This is represented | <t>This relates the object to other JSCalendar objects. This is repres | |||
as a map of the UIDs of the related objects to information about the relation.< | ented as a map of the UIDs of | |||
/t> | the related objects to information about the relation.</t> | |||
<t>If an object is split to make a "this and future" change to a recur | ||||
<t>If an object is split to make a "this and future" change to a recur | rence, the original object <bcp14>MUST</bcp14> be truncated to end at the previo | |||
rence, the original object MUST be truncated to end at the previous occurrence b | us occurrence before this split, and a new object is created to represent all th | |||
efore this split, and a new object created to represent all the occurrences afte | e occurrences after the split. A <tt>next</tt> relation <bcp14>MUST</bcp14> be s | |||
r the split. A <spanx style="verb">next</spanx> relation MUST be set on the orig | et on the original object's <tt>relatedTo</tt> property for the UID of the new o | |||
inal object's relatedTo property for the UID of the new object. A <spanx style=" | bject. A <tt>first</tt> relation for the UID of the first object in the series < | |||
verb">first</spanx> relation for the UID of the first object in the series MUST | bcp14>MUST</bcp14> be set on the new object. Clients can then follow these UIDs | |||
be set on the new object. Clients can then follow these UIDs to get the complete | to get the complete set of objects if the user wishes to modify them all at once | |||
set of objects if the user wishes to modify them all at once.</t> | .</t> | |||
</section> | </section> | |||
<section anchor="prop-prodId" numbered="true" toc="default"> | ||||
<section anchor="prop-prodId" title="prodId"> | <name>prodId</name> | |||
<t>Type: <spanx style="verb">String</spanx> (optional).</t> | <t>Type: <tt>String</tt> (optional)</t> | |||
<t>This is the identifier for the product that last updated the JSCale | ||||
<t>The identifier for the product that last updated the JSCalendar obj | ndar object. This should be set whenever the data in the object is modified (i.e | |||
ect. This should be set whenever the data in the object is modified (i.e., whene | ., whenever the <tt>updated</tt> property is set).</t> | |||
ver the "updated" property is set).</t> | <t>The vendor of the implementation <bcp14>MUST</bcp14> ensure that th | |||
is is a globally unique identifier, using some technique such as a Formal Public | ||||
<t>The vendor of the implementation MUST ensure that this is a globall | Identifier (FPI) value, as defined in <xref target="ISO.9070.1991"/>.</t> | |||
y unique identifier, using some technique such as an FPI value, as defined in [I | <t>This property <bcp14>SHOULD NOT</bcp14> be used to alter the interp | |||
SO.9070.1991].</t> | retation of a JSCalendar object beyond the semantics specified in this document. | |||
For example, it is not to be used to further the understanding of nonstandard p | ||||
<t>This property SHOULD NOT be used to alter the interpretation of a J | roperties, a practice that is known to cause long-term interoperability problems | |||
SCalendar object beyond the semantics specified in this document. For example, i | .</t> | |||
t is not to be used to further the understanding of non-standard properties, a p | ||||
ractice that is known to cause long-term interoperability problems.</t> | ||||
</section> | </section> | |||
<section anchor="prop-created" numbered="true" toc="default"> | ||||
<section anchor="prop-created" title="created"> | <name>created</name> | |||
<t>Type: <spanx style="verb">UTCDateTime</spanx> (optional).</t> | <t>Type: <tt>UTCDateTime</tt> (optional)</t> | |||
<t>This is the date and time this object was initially created.</t> | ||||
<t>The date and time this object was initially created.</t> | ||||
</section> | </section> | |||
<section anchor="prop-updated" numbered="true" toc="default"> | ||||
<section anchor="prop-updated" title="updated"> | <name>updated</name> | |||
<t>Type: <spanx style="verb">UTCDateTime</spanx> (mandatory).</t> | <t>Type: <tt>UTCDateTime</tt> (mandatory)</t> | |||
<t>This is the date and time the data in this object was last modified | ||||
<t>The date and time the data in this object was last modified (or its | (or its creation date/time if | |||
creation date/time if not modified since).</t> | not modified since).</t> | |||
</section> | </section> | |||
<section anchor="prop-sequence" numbered="true" toc="default"> | ||||
<section anchor="prop-sequence" title="sequence"> | <name>sequence</name> | |||
<t>Type: <spanx style="verb">UnsignedInt</spanx> (optional, default: 0 | <t>Type: <tt>UnsignedInt</tt> (optional, default: 0)</t> | |||
).</t> | <t>Initially zero, this <bcp14>MUST</bcp14> be incremented by one ever | |||
y time a change is made to the | ||||
<t>Initially zero, this MUST be incremented by one every time a change | object, except if the change only modifies the <tt>participants</tt> | |||
is made to the object, except if the change only modifies the <spanx style="ver | property (see <xref | |||
b">participants</spanx> property (see <xref target="prop-participants" />).</t> | target="prop-participants" format="default"/>).</t> | |||
<t>This is used as part of the iCalendar Transport-independent Interop | ||||
<t>This is used as part of iTIP <xref target="RFC5546" /> to know whic | erability Protocol (iTIP) <xref | |||
h version of the object a scheduling message relates to.</t> | target="RFC5546" format="default"/> to know which version of the obje | |||
ct a scheduling message relates | ||||
to.</t> | ||||
</section> | </section> | |||
<section anchor="prop-method" numbered="true" toc="default"> | ||||
<section anchor="prop-method" title="method"> | <name>method</name> | |||
<t>Type: <spanx style="verb">String</spanx> (optional).</t> | <t>Type: <tt>String</tt> (optional)</t> | |||
<t>This is the iTIP <xref target="RFC5546" format="default"/> method, | ||||
<t>The iTIP <xref target="RFC5546" /> method, in lowercase. This MUST | in lowercase. This <bcp14>MUST</bcp14> | |||
only be present if the JSCalendar object represents an iTIP scheduling message.< | only be present if the JSCalendar object represents an iTIP schedulin | |||
/t> | g message.</t> | |||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="whatwhere-properties" numbered="true" toc="default"> | ||||
<section anchor="whatwhere-properties" title="What and Where Properties"> | <name>What and Where Properties</name> | |||
<section anchor="prop-title" title="title"> | <section anchor="prop-title" numbered="true" toc="default"> | |||
<t>Type: <spanx style="verb">String</spanx> (optional, default: empty | <name>title</name> | |||
String).</t> | <t>Type: <tt>String</tt> (optional, default: empty String)</t> | |||
<t>This is a short summary of the object.</t> | ||||
<t>A short summary of the object.</t> | ||||
</section> | </section> | |||
<section anchor="prop-description" numbered="true" toc="default"> | ||||
<section anchor="prop-description" title="description"> | <name>description</name> | |||
<t>Type: <spanx style="verb">String</spanx> (optional, default: empty | <t>Type: <tt>String</tt> (optional, default: empty String)</t> | |||
String).</t> | <t>This is a longer-form text description of the object. The content i | |||
s formatted according to the | ||||
<t>A longer-form text description of the object. The content is format | <tt>descriptionContentType</tt> property.</t> | |||
ted according to the <spanx style="verb">descriptionContentType</spanx> property | ||||
.</t> | ||||
</section> | </section> | |||
<section anchor="prop-descriptionContentType" numbered="true" toc="defau | ||||
<section anchor="prop-descriptionContentType" title="descriptionContentT | lt"> | |||
ype"> | <name>descriptionContentType</name> | |||
<t>Type: <spanx style="verb">String</spanx> (optional, default: <spanx | <t>Type: <tt>String</tt> (optional, default: <tt>text/plain</tt>)</t> | |||
style="verb">text/plain</spanx>).</t> | <t>This describes the media type <xref target="RFC6838" format="defaul | |||
t"/> of the contents of the | ||||
<t>Describes the media type <xref target="RFC6838" /> of the contents | <tt>description</tt> property. Media types <bcp14>MUST</bcp14> be sub | |||
of the <spanx style="verb">description</spanx> property. Media types MUST be sub | types of type <tt>text</tt> and | |||
-types of type <spanx style="verb">text</spanx>, and SHOULD be <spanx style="ver | <bcp14>SHOULD</bcp14> be <tt>text/plain</tt> or <tt>text/html</tt> | |||
b">text/plain</spanx> or <spanx style="verb">text/html</spanx> <xref target="MED | <xref target="MEDIATYPES" | |||
IATYPES" />. They MAY include parameters and the <spanx style="verb">charset</sp | format="default"/>. They <bcp14>MAY</bcp14> include parameters, a | |||
anx> parameter value MUST be <spanx style="verb">utf-8</spanx>, if specified. De | nd the <tt>charset</tt> parameter | |||
scriptions of type <spanx style="verb">text/html</spanx> MAY contain <spanx styl | value <bcp14>MUST</bcp14> be <tt>utf-8</tt>, if specified. Descri | |||
e="verb">cid</spanx> URLs <xref target="RFC2392" /> to reference links in the ca | ptions of type <tt>text/html</tt> | |||
lendar object by use of the <spanx style="verb">cid</spanx> property of the Link | <bcp14>MAY</bcp14> contain <tt>cid</tt> URLs <xref target="RFC2 | |||
object.</t> | 392" format="default"/> to reference | |||
links in the calendar object by use of the <tt>cid</tt> prope | ||||
rty of the Link object.</t> | ||||
</section> | </section> | |||
<section anchor="prop-showWithoutTime" numbered="true" toc="default"> | ||||
<section anchor="prop-showWithoutTime" title="showWithoutTime"> | <name>showWithoutTime</name> | |||
<t>Type: <spanx style="verb">Boolean</spanx> (optional, default: false | <t>Type: <tt>Boolean</tt> (optional, default: false)</t> | |||
).</t> | <t>This indicates that the time is not important to display to the use | |||
r when rendering this calendar object. An example of this is an event that conce | ||||
<t>Indicates that the time is not important to display to the user whe | ptually occurs all day or across multiple days, such as "New Year's Day" or "Ita | |||
n rendering this calendar object. An example of this is an event that conceptual | ly Vacation". While the time component is important for free-busy calculations a | |||
ly occurs all day or across multiple days, such as "New Year's Day" or "Italy Va | nd checking for scheduling clashes, calendars may choose to omit displaying it a | |||
cation". While the time component is important for free-busy calculations and ch | nd/or display the object separately to other objects to enhance the user's view | |||
ecking for scheduling clashes, calendars may choose to omit displaying it and/or | of their schedule.</t> | |||
display the object separately to other objects to enhance the user's view of th | ||||
eir schedule.</t> | ||||
<t>Such events are also commonly known as "all-day" events.</t> | <t>Such events are also commonly known as "all-day" events.</t> | |||
</section> | </section> | |||
<section anchor="prop-locations" numbered="true" toc="default"> | ||||
<section anchor="prop-locations" title="locations"> | <name>locations</name> | |||
<t>Type: <spanx style="verb">Id[Location]</spanx> (optional).</t> | <t>Type: <tt>Id[Location]</tt> (optional)</t> | |||
<t>This is a map of location ids to Location objects, representing loc | ||||
<t>A map of location ids to Location objects, representing locations a | ations associated with the | |||
ssociated with the object.</t> | object.</t> | |||
<t>A Location object has the following properties. It <bcp14>MUST</bcp | ||||
<t>A Location object has the following properties. It MUST have at lea | 14> have at least one property | |||
st one property other than the <spanx style="verb">relativeTo</spanx> property.< | other than the <tt>relativeTo</tt> property.</t> | |||
/t> | <dl newline="true"> | |||
<dt>@type: <tt>String</tt> (mandatory)</dt> | ||||
<t><list style="symbols"> | <dd>This specifies the type of this object. This <bcp14>MUST</bcp1 | |||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | 4> be <tt>Location</tt>.</dd> | |||
<vspace blankLines="1" /> | <dt>name: <tt>String</tt> (optional)</dt> | |||
Specifies the type of this object. This MUST be <spanx style="verb"> | <dd>This is the human-readable name of the location.</dd> | |||
Location</spanx>. | <dt>description: <tt>String</tt> (optional)</dt> | |||
</t> | <dd>This is the human-readable, plain-text instructions for access | |||
<t>name: <spanx style="verb">String</spanx> (optional) | ing this location. This may be | |||
<vspace blankLines="1" /> | an address, set of directions, door access code, etc.</dd> | |||
The human-readable name of the location.</t> | <dt>locationTypes: <tt>String[Boolean]</tt> (optional)</dt> | |||
<dd>This is a set of one or more location types that describe this | ||||
<t>description: <spanx style="verb">String</spanx> (optional) | location. All types | |||
<vspace blankLines="1" /> | <bcp14>MUST</bcp14> be from the "Location Types Registry | |||
Human-readable, plain-text instructions for accessing this location. | " <xref target="LOCATIONTYPES" | |||
This may be an address, set of directions, door access code, etc.</t> | format="default"/>, as defined in <xref target="RFC4589 | |||
" format="default"/>. The set is | ||||
<t>locationTypes: <spanx style="verb">String[Boolean]</spanx> (optio | represented as a map, with the keys being the location | |||
nal) | types. The value for each key in the map | |||
<vspace blankLines="1" /> | <bcp14>MUST</bcp14> be true.</dd> | |||
A set of one or more location types that describe this location. All | <dt>relativeTo: <tt>String</tt> (optional)</dt> | |||
types MUST be from the Location Types Registry <xref target="LOCATIONTYPES" /> | <dd><t>This specifies the relation between this location and the t | |||
as defined in <xref target="RFC4589" />. The set is represented as a map, with t | ime of the JSCalendar object. | |||
he keys being the location types. The value for each key in the map MUST be true | This | |||
. | is primarily to allow events representing travel to spe | |||
</t> | cify the location of departure (at the | |||
start of the event) and location of arrival (at t | ||||
<t>relativeTo: <spanx style="verb">String</spanx> (optional) | he end); this is particularly important if these | |||
<vspace blankLines="1" /> | locations are in different time zones, as a | |||
Specifies the relation between this location and the time of the JSC | client may wish to highlight this information for the | |||
alendar object. This is primarily to allow events representing travel to specify | user.</t> | |||
the location of departure (at the start of the event) and location of arrival ( | <t>This <bcp14>MUST</bcp14> be one of the following values, anothe | |||
at the end); this is particularly important if these locations are in different | r value registered in the IANA | |||
time zones, as a client may wish to highlight this information for the user. | "JSCalendar Enum Values" registry, or a vendor-spec | |||
<vspace blankLines="1" /> | ific value (see <xref target="custom-properties" | |||
This MUST be one of the following values, another value registered i | format="default"/>). Any value the client or server doe | |||
n the IANA JSCalendar Enum Values registry, or a vendor-specific value (see <xre | sn't understand should be treated the same | |||
f target="custom-properties" />). Any value the client or server doesn't underst | as if this property is omitted.</t> | |||
and should be treated the same as if this property is omitted. | <dl> | |||
<list style="symbols"> | <dt><tt>start</tt>:</dt> | |||
<t><spanx style="verb">start</spanx>: The event/task described by | <dd>The event/task described by this JSCalendar object occurs at | |||
this JSCalendar object occurs at this location at the time the event/task starts | this location at the time the | |||
.</t> | event/task starts.</dd> | |||
<t><spanx style="verb">end</spanx>: The event/task described by th | <dt><tt>end</tt>:</dt> | |||
is JSCalendar object occurs at this location at the time the event/task ends.</t | <dd>The event/task described by this JSCalendar object occurs at | |||
> | this location at the time the | |||
</list></t> | event/task ends.</dd> | |||
</dl></dd> | ||||
<t>timeZone: <spanx style="verb">TimeZoneId</spanx> (optional) | <dt>timeZone: <tt>TimeZoneId</tt> (optional)</dt> | |||
<vspace blankLines="1" /> | <dd>This is a time zone for this location.</dd> | |||
A time zone for this location.</t> | <dt>coordinates: <tt>String</tt> (optional)</dt> | |||
<dd>This is a <tt>geo:</tt> URI <xref target="RFC5870" format="def | ||||
<t>coordinates: <spanx style="verb">String</spanx> (optional) | ault"/> for the location.</dd> | |||
<vspace blankLines="1" /> | <dt>links: <tt>Id[Link]</tt> (optional)</dt> | |||
A <spanx style="verb">geo:</spanx> URI <xref target="RFC5870" /> for | <dd>This is a map of link ids to Link objects, representing extern | |||
the location.</t> | al resources associated with | |||
this location, for example, a vCard or image. If there are no | ||||
<t>links: <spanx style="verb">Id[Link]</spanx> (optional) | links, this | |||
<vspace blankLines="1" /> | <bcp14>MUST</bcp14> be omitted (rather than specified a | |||
A map of link ids to Link objects, representing external resources a | s an empty set).</dd> | |||
ssociated with this location, for example a vCard or image. | </dl> | |||
If there are no links, this MUST be omitted (rather than specified a | ||||
s an empty set).</t> | ||||
</list></t> | ||||
</section> | </section> | |||
<section anchor="prop-virtualLocations" numbered="true" toc="default"> | ||||
<section anchor="prop-virtualLocations" title="virtualLocations"> | <name>virtualLocations</name> | |||
<t>Type: <spanx style="verb">Id[VirtualLocation]</spanx> (optional).</ | <t>Type: <tt>Id[VirtualLocation]</tt> (optional)</t> | |||
t> | <t>This is a map of virtual location ids to VirtualLocation objects, r | |||
epresenting virtual locations, | ||||
<t>A map of virtual location ids to VirtualLocation objects, represent | such as video conferences or chat rooms, associated with the object.< | |||
ing virtual locations, such as video conferences or chat rooms, associated with | /t> | |||
the object.</t> | ||||
<t>A VirtualLocation object has the following properties.</t> | <t>A VirtualLocation object has the following properties.</t> | |||
<t><list style="symbols"> | <dl newline="true"> | |||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | <dt>@type: <tt>String</tt> (mandatory)</dt> | |||
<vspace blankLines="1" /> | <dd>This specifies the type of this object. This <bcp14>MUST</bcp1 | |||
Specifies the type of this object. This MUST be <spanx style="verb"> | 4> be | |||
VirtualLocation</spanx>.</t> | <tt>VirtualLocation</tt>.</dd> | |||
<t>name: <spanx style="verb">String</spanx> (optional, default: empt | <dt>name: <tt>String</tt> (optional, default: empty String)</dt> | |||
y String) | <dd>This is the human-readable name of the virtual location.</dd> | |||
<vspace blankLines="1" /> | <dt>description: <tt>String</tt> (optional)</dt> | |||
The human-readable name of the virtual location.</t> | <dd>These are human-readable plain-text instructions for accessing | |||
this virtual location. This | ||||
<t>description: <spanx style="verb">String</spanx> (optional) | may be a conference access code, etc.</dd> | |||
<vspace blankLines="1" /> | <dt>uri: <tt>String</tt> (mandatory)</dt> | |||
Human-readable plain-text instructions for accessing this virtual lo | <dd><t>This is a URI <xref target="RFC3986" format="default"/> tha | |||
cation. This may be a conference access code, etc.</t> | t represents how to connect to | |||
this virtual location.</t> | ||||
<t>uri: <spanx style="verb">String</spanx> (mandatory) | <t>This may be a telephone number (represented using the <tt>tel:< | |||
<vspace blankLines="1" /> | /tt> scheme, e.g., | |||
A URI <xref target="RFC3986" /> that represents how to connect to th | <tt>tel:+1-555-555-5555</tt>) for a teleconference, a web add | |||
is virtual location. | ress for online chat, or any custom | |||
<vspace blankLines="1" /> | URI.</t></dd> | |||
This may be a telephone number (represented using the <spanx style=" | <dt>features: <tt>String[Boolean]</tt> (optional)</dt> | |||
verb">tel:</spanx> scheme, e.g., <spanx style="verb">tel:+1-555-555-5555</spanx> | <dd><t>A set of features supported by this virtual location. The s | |||
) for a teleconference, a web address for online chat, or any custom URI.</t> | et is represented as a map, with the keys being the feature. The value for each | |||
</list></t> | key in the map <bcp14>MUST</bcp14> be true.</t> | |||
<t>The feature <bcp14>MUST</bcp14> be one of the following values, | ||||
another value registered in the IANA "JSCalendar Enum Values" registr | ||||
y, or a vendor-specific value (see <xref target="custom-properties" />). Any val | ||||
ue the client or server doesn't understand should be treated the same as if this | ||||
feature is omitted.</t> | ||||
<dl> | ||||
<dt>audio:</dt> | ||||
<dd>Audio conferencing</dd> | ||||
<dt>chat:</dt> | ||||
<dd>Chat or instant messaging</dd> | ||||
<dt>feed:</dt> | ||||
<dd>Blog or atom feed</dd> | ||||
<dt>moderator:</dt> | ||||
<dd>Provides moderator-specific features</dd> | ||||
<dt>phone:</dt> | ||||
<dd>Phone conferencing</dd> | ||||
<dt>screen:</dt> | ||||
<dd>Screen sharing</dd> | ||||
<dt>video:</dt> | ||||
<dd>Video conferencing</dd> | ||||
</dl></dd> | ||||
</dl> | ||||
</section> | </section> | |||
<section anchor="prop-links" numbered="true" toc="default"> | ||||
<section anchor="prop-links" title="links"> | <name>links</name> | |||
<t>Type: <spanx style="verb">Id[Link]</spanx> (optional).</t> | <t>Type: <tt>Id[Link]</tt> (optional)</t> | |||
<t>This is a map of link ids to Link objects, representing external re | ||||
<t>A map of link ids to Link objects, representing external resources | sources associated with the | |||
associated with the object.</t> | object.</t> | |||
<t>Links with a rel of <tt>enclosure</tt> <bcp14>MUST</bcp14> be consi | ||||
<t>Links with a rel of <spanx style="verb">enclosure</spanx> MUST be c | dered by the client to be | |||
onsidered by the client as attachments for download. | attachments for download.</t> | |||
<vspace blankLines="1" /> | <t>Links with a rel of <tt>describedby</tt> <bcp14>MUST</bcp14> be | |||
Links with a rel of <spanx style="verb">describedby</spanx> MUST be co | considered by the client to be | |||
nsidered by the client to be an alternative representation of the description. | alternative representations of the description.</t> | |||
<vspace blankLines="1" /> | <t>Links with a rel of <tt>icon</tt> <bcp14>MUST</bcp14> be considered | |||
Links with a rel of <spanx style="verb">icon</spanx> MUST be considere | by the client to be images | |||
d by the client to be an image that it may use when presenting the calendar data | that it may use when presenting the calendar data to a user. The <tt> | |||
to a user. The <spanx style="verb">display</spanx> property may be set to indic | display</tt> property may be set | |||
ate the purpose of this image.</t> | to indicate the purpose of this image.</t> | |||
</section> | </section> | |||
<section anchor="prop-locale" numbered="true" toc="default"> | ||||
<section anchor="prop-locale" title="locale"> | <name>locale</name> | |||
<t>Type: <spanx style="verb">String</spanx> (optional).</t> | <t>Type: <tt>String</tt> (optional)</t> | |||
<t>This is the language tag, as defined in <xref target="BCP47" format | ||||
<t>The language tag as defined in <xref target="RFC5646" /> that best | ="default"/>, that best | |||
describes the locale used for the text in the calendar object, if known.</t> | describes the locale used for the text in the calendar object, if kno | |||
wn.</t> | ||||
</section> | </section> | |||
<section anchor="prop-keywords" numbered="true" toc="default"> | ||||
<section anchor="prop-keywords" title="keywords"> | <name>keywords</name> | |||
<t>Type: <spanx style="verb">String[Boolean]</spanx> (optional).</t> | <t>Type: <tt>String[Boolean]</tt> (optional)</t> | |||
<t>This is a set of keywords or tags that relate to the object. The se | ||||
<t>A set of keywords or tags that relate to the object. The set is rep | t is represented as a map, with | |||
resented as a map, with the keys being the keywords. The value for each key in t | the keys being the keywords. The value for each key in the map <bcp14 | |||
he map MUST be true.</t> | >MUST</bcp14> be true.</t> | |||
</section> | </section> | |||
<section anchor="prop-categories" numbered="true" toc="default"> | ||||
<section anchor="prop-categories" title="categories"> | <name>categories</name> | |||
<t>Type: <spanx style="verb">String[Boolean]</spanx> (optional).</t> | <t>Type: <tt>String[Boolean]</tt> (optional)</t> | |||
<t>This is a set of categories that relate to the calendar object. The | ||||
<t>A set of categories that relate to the calendar object. The set is | set is represented as a map, | |||
represented as a map, with the keys being the categories specified as URIs. The | with the | |||
value for each key in the map MUST be true.</t> | keys being the categories specified as URIs. The value for each key | |||
in the map <bcp14>MUST</bcp14> be | ||||
<t>In contrast to keywords, categories typically are structured. For e | true.</t> | |||
xample, a vendor owning the domain <spanx style="verb">example.com</spanx> might | <t>In contrast to keywords, categories are typically structured. For e | |||
define the categories <spanx style="verb">http://example.com/categories/sports/ | xample, a vendor owning the | |||
american-football</spanx> and <spanx style="verb">http://example.com/categories/ | domain <tt>example.com</tt> might define the categories | |||
music/r-b</spanx>.</t> | <tt>http://example.com/categories/sports/american-football</tt> and | |||
<tt>http://example.com/categories/music/r-b</tt>.</t> | ||||
</section> | </section> | |||
<section anchor="prop-color" numbered="true" toc="default"> | ||||
<section anchor="prop-color" title="color"> | <name>color</name> | |||
<t>Type: <spanx style="verb">String</spanx> (optional).</t> | <t>Type: <tt>String</tt> (optional)</t> | |||
<t>This is a color clients <bcp14>MAY</bcp14> use when displaying this | ||||
<t>A color clients MAY use when displaying this calendar object. The v | calendar object. The value is | |||
alue is a color name taken from the set of names defined in Section 4.3 of CSS C | a color name taken from the set of names defined in Section 4.3 of CS | |||
olor Module Level 3 <xref target="COLORS" />, or an RGB value in hexadecimal not | S Color Module Level 3 <xref | |||
ation, as defined in Section 4.2.1 of CSS Color Module Level 3.</t> | target="COLORS" format="default"/> or an RGB value in hexadecimal n | |||
otation, as defined in Section | ||||
4.2.1 of CSS Color Module Level 3.</t> | ||||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="recurrence-props" numbered="true" toc="default"> | ||||
<section anchor="recurrence-props" title="Recurrence Properties"> | <name>Recurrence Properties</name> | |||
<t>Some events and tasks occur at regular or irregular intervals. Rather | <t>Some events and tasks occur at regular or irregular intervals. Rather | |||
than having to copy the data for every occurrence there can be a master event w | than having to copy the data for every occurrence, there can be a base event wi | |||
ith rules to generate recurrences, and/or overrides that add extra dates or exce | th rules to generate recurrences and/or overrides that add extra dates or except | |||
ptions to the rules.</t> | ions to the rules.</t> | |||
<t>The recurrence set is the complete set of instances for an object. It is generated by considering the following properties in order, all of which are optional: | <t>The recurrence set is the complete set of instances for an object. It is generated by considering the following properties in order, all of which are optional: | |||
<list style="numbers"> | ||||
<t>The recurrenceRules property (<xref target="prop-recurrenceRules" | ||||
/>) generates a set of extra date-times on which the object occurs.</t> | ||||
<t>The excludedRecurrenceRules property (<xref target="prop-excluded | ||||
RecurrenceRules" />) generates a set of date-times that are to be removed from t | ||||
he previously generated set of date-times on which the object occurs.</t> | ||||
<t>The recurrenceOverrides property (<xref target="prop-recurrenceOv | ||||
errides" />) defines date-times which are added or excluded to form the final se | ||||
t. (This property may also contain changes to the object to apply to particular | ||||
instances.)</t> | ||||
</list> | ||||
</t> | </t> | |||
<ol spacing="normal" type="1"> | ||||
<section anchor="prop-recurrenceId" title="recurrenceId"> | <li>The <tt>recurrenceRules</tt> property (<xref target="prop-recurre | |||
<t>Type: <spanx style="verb">LocalDateTime</spanx> (optional).</t> | nceRules" | |||
format="default"/>) generates a set of extra date-times on which the | ||||
<t>If present, this JSCalendar object represents one occurrence of a r | object occurs.</li> | |||
ecurring JSCalendar object. If present the <spanx style="verb">recurrenceRules</ | <li>The <tt>excludedRecurrenceRules</tt> property (<xref target="prop- | |||
spanx> and <spanx style="verb">recurrenceOverrides</spanx> properties MUST NOT b | excludedRecurrenceRules" | |||
e present.</t> | format="default"/>) generates a set of date-times that are to be remo | |||
ved from the previously | ||||
<t>The value is a date-time either produced by the <spanx style="verb" | generated set of date-times on which the object occurs.</li> | |||
>recurrenceRules</spanx> of the master event, or added as a key to the <spanx st | <li>The <tt>recurrenceOverrides</tt> property (<xref target="prop-recu | |||
yle="verb">recurrenceOverrides</spanx> property of the master event.</t> | rrenceOverrides" format="default"/>) | |||
defines date-times that are added or excluded to form the final set. | ||||
(This property may also contain | ||||
changes to the object to apply to particular instances.)</li> | ||||
</ol> | ||||
<section anchor="prop-recurrenceId" numbered="true" toc="default"> | ||||
<name>recurrenceId</name> | ||||
<t>Type: <tt>LocalDateTime</tt> (optional)</t> | ||||
<t>If present, this JSCalendar object represents one occurrence of a r | ||||
ecurring JSCalendar object. If | ||||
present, the <tt>recurrenceRules</tt> and <tt>recurrenceOverrides</tt | ||||
> properties <bcp14>MUST | ||||
NOT</bcp14> be present.</t> | ||||
<t>The value is a date-time either produced by the <tt>recurrenceRules | ||||
</tt> of the base event or | ||||
added as a key to the <tt>recurrenceOverrides</tt> property of the ba | ||||
se event.</t> | ||||
</section> | </section> | |||
<section anchor="prop-recurrenceIdTimeZone" numbered="true" toc="default | ||||
"> | ||||
<name>recurrenceIdTimeZone</name> | ||||
<t>Type: <tt>TimeZoneId|null</tt> (optional, default: null)</t> | ||||
<t> Identifies the time zone of the main JSCalendar object, of which t | ||||
his JSCalendar object is a recurrence instance. This property <bcp14>MUST</bcp14 | ||||
> be set if the <tt>recurrenceId</tt> property is set. It <bcp14>MUST NOT</bcp14 | ||||
> be set if the <tt>recurrenceId</tt> property is not set.</t> | ||||
</section> | ||||
<section anchor="prop-recurrenceRules" numbered="true" toc="default"> | ||||
<name>recurrenceRules</name> | ||||
<t>Type: <tt>RecurrenceRule[]</tt> (optional)</t> | ||||
<t>This defines a set of recurrence rules (repeating patterns) for rec | ||||
urring calendar objects.</t> | ||||
<t>An Event recurs by applying the recurrence rules to the <tt>start</ | ||||
tt> date-time.</t> | ||||
<t>A Task recurs by applying the recurrence rules to the <tt>start</tt | ||||
> date-time, if defined; | ||||
otherwise, it recurs by the <tt>due</tt> date-time, if defined. If th | ||||
e task defines neither a | ||||
<tt>start</tt> nor <tt>due</tt> date-time, it <bcp14>MUST NOT</bcp1 | ||||
4> define a | ||||
<tt>recurrenceRules</tt> property.</t> | ||||
<t>If multiple recurrence rules are given, each rule is to be applied, | ||||
and then the union of the | ||||
results are used, ignoring any duplicates.</t> | ||||
<t>A RecurrenceRule object is a JSON object mapping of a RECUR value t | ||||
ype in iCalendar <xref | ||||
target="RFC5545" format="default"/> <xref target="RFC7529" format="de | ||||
fault"/> and has the same | ||||
semantics. It has the following properties:</t> | ||||
<dl newline="true"> | ||||
<dt>@type: <tt>String</tt> (mandatory)</dt> | ||||
<dd>This specifies the type of this object. This <bcp14>MUST</bcp1 | ||||
4> be | ||||
<tt>RecurrenceRule</tt>.</dd> | ||||
<dt>frequency: <tt>String</tt> (mandatory)</dt> | ||||
<dd><t>This is the time span covered by each iteration of this rec | ||||
urrence rule (see <xref | ||||
target="recurrence-semantics" format="default"/> for full sem | ||||
antics). This <bcp14>MUST</bcp14> be | ||||
one of the following values:</t> | ||||
<ul spacing="normal"> | ||||
<li><tt>yearly</tt></li> | ||||
<li><tt>monthly</tt></li> | ||||
<li><tt>weekly</tt></li> | ||||
<li><tt>daily</tt></li> | ||||
<li><tt>hourly</tt></li> | ||||
<li><tt>minutely</tt></li> | ||||
<li><tt>secondly</tt></li> | ||||
</ul> | ||||
<t>This is the FREQ part from iCalendar, converted to lowercase.</ | ||||
t> | ||||
</dd> | ||||
<dt>interval: <tt>UnsignedInt</tt> (optional, default: 1)</dt> | ||||
<dd><t>This is the interval of iteration periods at which the recu | ||||
rrence repeats. If included, it | ||||
<bcp14>MUST</bcp14> be an integer >= 1.</t> | ||||
<t>This is the INTERVAL part from iCalendar.</t></dd> | ||||
<dt>rscale: <tt>String</tt> (optional, default: "gregorian")</dt> | ||||
<dd><t>This is the calendar system in which this recurrence rule o | ||||
perates, in lowercase. This | ||||
<bcp14>MUST</bcp14> be either a CLDR-registered calendar syst | ||||
em name <xref target="CLDR" | ||||
format="default"/> or a vendor-specific value (see <xre | ||||
f target="custom-properties" | ||||
format="default"/>).</t> | ||||
<t>This is the RSCALE part from iCalendar <xref target="RFC7529" f | ||||
ormat="default">RSCALE</xref>, | ||||
converted to lowercase.</t> | ||||
</dd> | ||||
<dt>skip: <tt>String</tt> (optional, default: "omit")</dt> | ||||
<dd><t>This is the behavior to use when the expansion of the recur | ||||
rence produces invalid dates. | ||||
This | ||||
property only has an effect if the frequency is "yearly | ||||
" or "monthly". It <bcp14>MUST</bcp14> be | ||||
one of the following values:</t> | ||||
<ul spacing="normal"> | ||||
<li><tt>omit</tt></li> | ||||
<li><tt>backward</tt></li> | ||||
<li><tt>forward</tt></li> | ||||
</ul> | ||||
<t>This is the SKIP part from iCalendar <xref target="RFC7529" for | ||||
mat="default">RSCALE</xref>, | ||||
converted to lowercase.</t> | ||||
</dd> | ||||
<dt>firstDayOfWeek: <tt>String</tt> (optional, default: "mo")</dt> | ||||
<dd><t>This is the day on which the week is considered to start, r | ||||
epresented as a lowercase, | ||||
abbreviated, and two-letter English day of the week. If inclu | ||||
ded, it <bcp14>MUST</bcp14> be one | ||||
of the following values:</t> | ||||
<ul spacing="normal"> | ||||
<li><tt>mo</tt></li> | ||||
<li><tt>tu</tt></li> | ||||
<li><tt>we</tt></li> | ||||
<li><tt>th</tt></li> | ||||
<li><tt>fr</tt></li> | ||||
<li><tt>sa</tt></li> | ||||
<li><tt>su</tt></li> | ||||
</ul> | ||||
<t>This is the WKST part from iCalendar.</t> | ||||
</dd> | ||||
<dt>byDay: <tt>NDay[]</tt> (optional)</dt> | ||||
<dd><t>These are days of the week on which to repeat. An <tt>NDay< | ||||
/tt> object has the following | ||||
properties:</t> | ||||
<dl newline="true"> | ||||
<dt>@type: <tt>String</tt> (mandatory)</dt> | ||||
<dd>This specifies the type of this object. This <bcp14>MUST</ | ||||
bcp14> be <tt>NDay</tt>.</dd> | ||||
<dt>day: <tt>String</tt> (mandatory)</dt> | ||||
<dd><t>This is a day of the week on which to repeat; the allow | ||||
ed values are the same as for | ||||
the <tt>firstDayOfWeek</tt> recurrenceRule property.</t> | ||||
<t>This is the day of the week of the BYDAY part in iCalendar, | ||||
converted to lowercase.</t> | ||||
</dd> | ||||
<dt>nthOfPeriod: <tt>Int</tt> (optional)</dt> | ||||
<dd><t>If present, rather than representing every occurrence o | ||||
f the weekday defined in the | ||||
<tt>day</tt> property, it represents only a specific instance | ||||
within the recurrence period. | ||||
The value can be positive or negative but <bcp14>MUST NOT</ | ||||
bcp14> be zero. A negative integer means the nth-last occurrence within that per | ||||
iod (i.e., -1 is the last occurrence, -2 the one before that, etc.).</t> | ||||
<t>This is the ordinal part of the BYDAY value in iCalendar (e | ||||
.g., 1 or -3).</t> | ||||
</dd> | ||||
</dl> | ||||
</dd> | ||||
<dt>byMonthDay: <tt>Int[]</tt> (optional) | ||||
</dt> | ||||
<dd><t>These are the days of the month on which to repeat. Valid v | ||||
alues are between 1 and the | ||||
maximum number of | ||||
days any month may have in the calendar given by the <t | ||||
t>rscale</tt> property and the negative values | ||||
of these numbers. For example, in the Gregorian c | ||||
alendar, valid values are 1 to 31 and -31 to -1. | ||||
Negative values offset from the end of the | ||||
month. The array <bcp14>MUST</bcp14> have at least one | ||||
entry if included.</t> | ||||
<t>This is the BYMONTHDAY part in iCalendar.</t> | ||||
</dd> | ||||
<dt>byMonth: <tt>String[]</tt> (optional)</dt> | ||||
<dd><t>These are the months in which to repeat. Each entry is a st | ||||
ring representation of a | ||||
number, starting | ||||
from "1" for the first month in the calendar (e.g., "1" | ||||
means January with the Gregorian | ||||
calendar), with an optional "L" suffix (see <xref | ||||
target="RFC7529" format="default"/>) for leap | ||||
months (this <bcp14>MUST</bcp14> be upperca | ||||
se, e.g., "3L"). The array <bcp14>MUST</bcp14> have at | ||||
least one entry if included.</t> | ||||
<t>This is the BYMONTH part from iCalendar.</t> | ||||
</dd> | ||||
<dt>byYearDay: <tt>Int[]</tt> (optional)</dt> | ||||
<dd><t>These are the days of the year on which to repeat. Valid va | ||||
lues are between 1 and the | ||||
maximum number | ||||
of days any year may have in the calendar given by the | ||||
<tt>rscale</tt> property and the negative values | ||||
of these numbers. For example, in the Gregorian c | ||||
alendar, valid values are 1 to 366 and -366 to | ||||
-1. Negative values offset from the end of | ||||
the year. The array <bcp14>MUST</bcp14> have at least | ||||
one entry if included.</t> | ||||
<t>This is the BYYEARDAY part from iCalendar.</t> | ||||
</dd> | ||||
<dt>byWeekNo: <tt>Int[]</tt> (optional)</dt> | ||||
<dd><t>These are the weeks of the year in which to repeat. Valid v | ||||
alues are between 1 and the | ||||
maximum number of | ||||
weeks any year may have in the calendar given by the <t | ||||
t>rscale</tt> property and the negative values | ||||
of these numbers. For example, in the Gregorian c | ||||
alendar, valid values are 1 to 53 and -53 to -1. | ||||
The array <bcp14>MUST</bcp14> have at least | ||||
one entry if included.</t> | ||||
<t>This is the BYWEEKNO part from iCalendar.</t> | ||||
</dd> | ||||
<dt>byHour: <tt>UnsignedInt[]</tt> (optional)</dt> | ||||
<dd><t>These are the hours of the day in which to repeat. Valid va | ||||
lues are 0 to 23. The array | ||||
<bcp14>MUST</bcp14> have at least one entry if included. This | ||||
is the BYHOUR part from | ||||
iCalendar.</t> | ||||
</dd> | ||||
<dt>byMinute: <tt>UnsignedInt[]</tt> (optional) | ||||
</dt> | ||||
<dd><t>These are the minutes of the hour in which to repeat. Valid | ||||
values are 0 to 59. The array | ||||
<bcp14>MUST</bcp14> have at least one entry if included.</t> | ||||
<t>This is the BYMINUTE part from iCalendar.</t> | ||||
</dd> | ||||
<dt>bySecond: <tt>UnsignedInt[]</tt> (optional)</dt> | ||||
<dd><t>These are the seconds of the minute in which to repeat. Val | ||||
id values are 0 to 60. The | ||||
array <bcp14>MUST</bcp14> have at least one entry if included | ||||
.</t> | ||||
<t>This is the BYSECOND part from iCalendar.</t> | ||||
</dd> | ||||
<dt>bySetPosition: <tt>Int[]</tt> (optional)</dt> | ||||
<dd>These are the occurrences within the recurrence interval to in | ||||
clude in the final results. | ||||
Negative values offset from the end of the list of occurrence | ||||
s. The array <bcp14>MUST</bcp14> | ||||
have at least one entry if included. This is the BYSETP | ||||
OS part from iCalendar.</dd> | ||||
<dt>count: <tt>UnsignedInt</tt> (optional)</dt> | ||||
<dd><t>These are the number of occurrences at which to range-bound | ||||
the recurrence. This | ||||
<bcp14>MUST | ||||
NOT</bcp14> be included if an <tt>until</tt> property i | ||||
s specified.</t> | ||||
<t>This is the COUNT part from iCalendar.</t> | ||||
</dd> | ||||
<dt>until: <tt>LocalDateTime</tt> (optional)</dt> | ||||
<dd><t>These are the date-time at which to finish recurring. The l | ||||
ast occurrence is on or before | ||||
this | ||||
date-time. This <bcp14>MUST NOT</bcp14> be included if | ||||
a <tt>count</tt> property is specified. | ||||
Note that if not specified otherwise for a specif | ||||
ic JSCalendar object, this date is to be | ||||
interpreted | ||||
in the time zone specified in the JSC | ||||
alendar object's <tt>timeZone</tt> property.</t> | ||||
<t>This is the UNTIL part from iCalendar.</t> | ||||
</dd> | ||||
</dl> | ||||
<section anchor="recurrence-semantics" numbered="true" toc="default"> | ||||
<name>Interpreting Recurrence Rules</name> | ||||
<t>A recurrence rule specifies a set of date-times for recurring cal | ||||
endar objects. A recurrence | ||||
rule has the following semantics. Note that wherever "year", "mon | ||||
th", or "day of month" is used, | ||||
this is | ||||
within the calendar system given by the <tt>rscale</tt> p | ||||
roperty, which defaults to "gregorian" if | ||||
omitted.</t> | ||||
<ol spacing="normal" type="1"><li> | ||||
<t>A set of candidates is generated. This is every second within | ||||
a period defined by the | ||||
<tt>frequency</tt> property value:</t> | ||||
<dl> | ||||
<dt><tt>yearly</tt>:</dt> | ||||
<dd><t>every second from midnight on the first day of a y | ||||
ear (inclusive) to midnight the first | ||||
day of the following year (exclusive).</t> | ||||
<t>If skip is not "omit", the calendar system has | ||||
leap months, and there is a <tt>byMonth</tt> | ||||
property, generate candidates for the leap mo | ||||
nths, even if they don't occur in this | ||||
year.</t> | ||||
<t> | ||||
If skip is not "omit" and there is a <tt>byMonthDay</tt> propert | ||||
y, presume each month has the maximum number of days any month may have in this | ||||
calendar system when generating candidates, even if it's more than this month ac | ||||
tually has.</t> | ||||
</dd> | ||||
<dt><tt>monthly</tt>:</dt><dd><t>every second from midnight | ||||
on the first day of a month (inclusive) to midnight on the first of the followin | ||||
g month (exclusive). | ||||
</t> | ||||
<t> | ||||
If skip is not "omit" and there is a <tt>byMonthDay</tt> propert | ||||
y, presume the month has the maximum number of days any month may have in this c | ||||
alendar system when generating candidates, even if it's more than this month act | ||||
ually has.</t></dd> | ||||
<dt><tt>weekly</tt>:</dt><dd>every second from midnight (incl | ||||
usive) on the first day of the week (as defined by the <tt>firstDayOfWeek</tt> p | ||||
roperty or Monday if omitted) to midnight seven days later (exclusive).</dd> | ||||
<dt><tt>daily</tt>:</dt><dd>every second from midnight at th | ||||
e start of the day (inclusive) to midnight at the end of the day (exclusive).</d | ||||
d> | ||||
<dt><tt>hourly</tt>:</dt><dd> every second from the beginnin | ||||
g of the hour (inclusive) to the beginning of the next hour (exclusive).</dd> | ||||
<dt><tt>minutely</tt>:</dt><dd> every second from the beginn | ||||
ing of the minute (inclusive) to the beginning of the next minute (exclusive).</ | ||||
dd> | ||||
<dt><tt>secondly</tt>:</dt><dd>only the second itself.</dd> | ||||
</dl> | ||||
</li> | ||||
<li> | ||||
<t>Each date-time candidate is compared against all of the byX p | ||||
roperties of the rule except bySetPosition. If any property in the rule does not | ||||
match the date-time, the date-time is eliminated. Each byX property is an array | ||||
; the date-time matches the property if it matches any of the values in the arra | ||||
y. The properties have the following semantics: | ||||
<section anchor="prop-recurrenceRules" title="recurrenceRules"> | </t> | |||
<t>Type: <spanx style="verb">RecurrenceRule[]</spanx> (optional).</t> | <dl> | |||
<dt>byMonth:</dt> | ||||
<t>Defines a set of recurrence rules (repeating patterns) for recurrin | <dd>The date-time is in the given month.</dd> | |||
g calendar objects.</t> | <dt>byWeekNo:</dt> | |||
<dd><t>The date-time is in the nth week of the year. Nega | ||||
<t>A JSEvent recurs by applying the recurrence rules to the <spanx sty | tive numbers mean the nth last week of the year. This corresponds to weeks accor | |||
le="verb">start</spanx> date-time.</t> | ding to week numbering, as defined in ISO.8601.2004, with a week defined as a se | |||
ven-day period, starting on the <tt>firstDayOfWeek</tt> property value or Monday | ||||
<t>A JSTask recurs by applying the recurrence rules to the <spanx styl | if omitted. Week number one of the calendar year is the first week that contain | |||
e="verb">start</spanx> date-time, if defined, otherwise it recurs by the <spanx | s at least four days in that calendar year.</t> | |||
style="verb">due</spanx> date-time, if defined. If the task defines neither a <s | <t> | |||
panx style="verb">start</spanx> nor <spanx style="verb">due</spanx> date-time, i | If the date-time is not valid (this may happen when generating c | |||
t MUST NOT define a <spanx style="verb">recurrenceRules</spanx> property.</t> | andidates with a <tt>skip</tt> property in effect), it is always eliminated by t | |||
his property.</t></dd> | ||||
<t>If multiple recurrence rules are given, each rule is to be applied | <dt>byYearDay:</dt> | |||
and then the union of the results used, ignoring any duplicates.</t> | <dd><t>The date-time is on the nth day of year. Negative | |||
numbers mean the nth last day of | ||||
<t>A RecurrenceRule object is a JSON object mapping of a RECUR value t | the year.</t> | |||
ype in iCalendar <xref target="RFC5545" /> <xref target="RFC7529" /> and has the | <t>If the date-time is not valid (this may happen when gener | |||
same semantics. It has the following properties: | ating candidates with a <tt>skip</tt> | |||
property in effect), it is always eliminated by this prop | ||||
<list style="symbols"> | erty.</t></dd> | |||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | <dt>byMonthDay:</dt> | |||
<vspace blankLines="1" /> | <dd>The date-time is on the given day of the month. Negative | |||
Specifies the type of this object. This MUST be <spanx style="verb"> | numbers mean the nth last day of | |||
RecurrenceRule</spanx>.</t> | the month.</dd> | |||
<t>frequency: <spanx style="verb">String</spanx> (mandatory) | <dt>byDay:</dt> | |||
<vspace blankLines="1" /> | <dd>The date-time is on the given day of the week. If the day | |||
The time span covered by each iteration of this recurrence rule (see | is prefixed by a number, it is the nth occurrence of that day of the week withi | |||
<xref target="recurrence-semantics" /> for full semantics). This MUST be one of | n the month (if frequency is monthly) or year (if frequency is yearly). Negative | |||
the following values: | numbers mean the nth last occurrence within that period.</dd> | |||
<dt>byHour:</dt> | ||||
<list style="symbols"> | <dd>The date-time has the given hour value.</dd> | |||
<t><spanx style="verb">yearly</spanx></t> | <dt>byMinute:</dt> | |||
<t><spanx style="verb">monthly</spanx></t> | <dd>The date-time has the given minute value.</dd> | |||
<t><spanx style="verb">weekly</spanx></t> | <dt>bySecond:</dt> | |||
<t><spanx style="verb">daily</spanx></t> | <dd>The date-time has the given second value.</dd> | |||
<t><spanx style="verb">hourly</spanx></t> | </dl> | |||
<t><spanx style="verb">minutely</spanx></t> | <t>If a <tt>skip</tt> property is defined and is not "omit", the | |||
<t><spanx style="verb">secondly</spanx></t> | re may be candidates that do not | |||
</list> | correspond to valid dates (e.g., February 31st in the Gregorian c | |||
alendar). In this case, the | ||||
This is the FREQ part from iCalendar, converted to lowercase.</t> | properties <bcp14>MUST</bcp14> be considered in the order above, | |||
and:</t> | ||||
<t>interval: <spanx style="verb">UnsignedInt</spanx> (optional, defa | <ol spacing="normal" type="1"> | |||
ult: 1) | <li>After applying the byMonth filter, if the candidate's mon | |||
<vspace blankLines="1" /> | th is invalid for the given year, increment it (if skip is "forward") or decreme | |||
The interval of iteration periods at which the recurrence repeats. I | nt it (if skip is "backward") until a valid month is found, incrementing/decreme | |||
f included, it MUST be an integer >= 1. | nting the year as well if passing through the beginning/end of the year. This on | |||
<vspace blankLines="1" /> | ly applies to calendar systems with leap months.</li> | |||
This is the INTERVAL part from iCalendar.</t> | <li>After applying the byMonthDay filter, if the day of the mo | |||
nth is invalid for the given month and year, change the date to the first day of | ||||
<t>rscale: <spanx style="verb">String</spanx> (optional, default: "g | the next month (if skip is "forward") or the last day of the current month (if | |||
regorian") | skip is "backward").</li> | |||
<vspace blankLines="1" /> | <li>If any valid date produced after applying the skip is alre | |||
The calendar system in which this recurrence rule operates, in lower | ady a candidate, eliminate the duplicate. (For example, after adjusting, Februar | |||
case. This MUST be either a CLDR-registered calendar system name <xref target="C | y 30th and February 31st would both become the same "real" date, so one is elimi | |||
LDR" />, or a vendor-specific value (see <xref target="custom-properties" />). | nated as a duplicate.)</li> | |||
<vspace blankLines="1" /> | </ol> | |||
This is the RSCALE part from iCalendar <xref target="RFC7529">RSCALE | </li> | |||
</xref>, converted to lowercase.</t> | <li>If a <tt>bySetPosition</tt> property is included, this is now | |||
applied to the ordered list of remaining dates. This property specifies the inde | ||||
<t>skip: <spanx style="verb">String</spanx> (optional, default: "omi | xes of date-times to keep; all others should be eliminated. Negative numbers are | |||
t") | indexed from the end of the list, with -1 being the last item, -2 the second fr | |||
<vspace blankLines="1" /> | om last, etc.</li> | |||
The behaviour to use when the expansion of the recurrence produces i | <li>Any date-times before the start date of the event are eliminat | |||
nvalid dates. This property only has an effect if the frequency is "yearly" or " | ed (see below for why this might be needed).</li> | |||
monthly". It MUST be one of the following values: | <li>If a <tt>skip</tt> property is included and is not "omit", eli | |||
minate any date-times that have already been produced by previous iterations of | ||||
<list style="symbols"> | the algorithm. (This is not possible if skip is "omit".)</li> | |||
<t><spanx style="verb">omit</spanx></t> | <li>If further dates are required (we have not reached the until d | |||
<t><spanx style="verb">backward</spanx></t> | ate or count limit), skip the next (interval - 1) sets of candidates, then conti | |||
<t><spanx style="verb">forward</spanx></t> | nue from step 1.</li> | |||
</list> | </ol> | |||
<t>When determining the set of occurrence dates for an event or task | ||||
This is the SKIP part from iCalendar <xref target="RFC7529">RSCALE</ | , the following extra rules | |||
xref>, converted to lowercase.</t> | must be applied:</t> | |||
<ol spacing="normal" type="1"> | ||||
<t>firstDayOfWeek: <spanx style="verb">String</spanx> (optional, def | <li>The initial date-time to which the rule is applied (the < | |||
ault: "mo") | tt>start</tt> date-time for events | |||
<vspace blankLines="1" /> | or the <tt>start</tt> or <tt>due</tt> date-time for tas | |||
The day on which the week is considered to start, represented as a l | ks) is always the first occurrence in the | |||
owercase abbreviated two-letter English day of the week. If included, it MUST be | expansion (and is counted if the recurrence is li | |||
one of the following values: | mited by a <tt>count</tt> property), even if it would | |||
normally not match the rule.</li> | ||||
<list style="symbols"> | <li>The first set of candidates to consider is that which would co | |||
<t><spanx style="verb">mo</spanx></t> | ntain the initial date-time. | |||
<t><spanx style="verb">tu</spanx></t> | ||||
<t><spanx style="verb">we</spanx></t> | ||||
<t><spanx style="verb">th</spanx></t> | ||||
<t><spanx style="verb">fr</spanx></t> | ||||
<t><spanx style="verb">sa</spanx></t> | ||||
<t><spanx style="verb">su</spanx></t> | ||||
</list> | ||||
This is the WKST part from iCalendar.</t> | ||||
<t>byDay: <spanx style="verb">NDay[]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
Days of the week on which to repeat. An <spanx style="verb">NDay</sp | ||||
anx> object has the following properties: | ||||
<list style="symbols"> | ||||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | ||||
<vspace blankLines="1" /> | ||||
Specifies the type of this object. This MUST be <spanx style="verb | ||||
">NDay</spanx>.</t> | ||||
<t>day: <spanx style="verb">String</spanx> (mandatory) | ||||
<vspace blankLines="1" /> | ||||
A day of the week on which to repeat; the allowed values are the s | ||||
ame as for the <spanx style="verb">firstDayOfWeek</spanx> RecurrenceRule propert | ||||
y. | ||||
<vspace blankLines="1" /> | ||||
This is the day-of-the-week of the BYDAY part in iCalendar, conver | ||||
ted to lowercase.</t> | ||||
<t>nthOfPeriod: <spanx style="verb">Int</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
If present, rather than representing every occurrence of the weekd | ||||
ay defined in the <spanx style="verb">day</spanx> property, it represents only a | ||||
specific instance within the recurrence period. The value can be positive or ne | ||||
gative, but MUST NOT be zero. A negative integer means nth-last of period. | ||||
<vspace blankLines="1" /> | ||||
This is the ordinal part of the BYDAY value in iCalendar (e.g., 1 | ||||
or -3).</t> | ||||
</list></t> | ||||
<t>byMonthDay: <spanx style="verb">Int[]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
Days of the month on which to repeat. Valid values are between 1 and | ||||
the maximum number of days any month may have in the calendar given by the "rsc | ||||
ale" property, and the negative values of these numbers. For example, in the Gre | ||||
gorian calendar valid values are 1 to 31 and -31 to -1. Negative values offset f | ||||
rom the end of the month. The array MUST have at least one entry if included. | ||||
<vspace blankLines="1" /> | ||||
This is the BYMONTHDAY part in iCalendar.</t> | ||||
<t>byMonth: <spanx style="verb">String[]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The months in which to repeat. Each entry is a string representation | ||||
of a number, starting from "1" for the first month in the calendar (e.g., "1" m | ||||
eans January with the Gregorian calendar), with an optional "L" suffix (see <xre | ||||
f target="RFC7529" />) for leap months (this MUST be uppercase, e.g., "3L"). The | ||||
array MUST have at least one entry if included. | ||||
<vspace blankLines="1" /> | ||||
This is the BYMONTH part from iCalendar.</t> | ||||
<t>byYearDay: <spanx style="verb">Int[]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The days of the year on which to repeat. Valid values are between 1 | ||||
and the maximum number of days any year may have in the calendar given by the "r | ||||
scale" property, and the negative values of these numbers. For example, in the G | ||||
regorian calendar valid values are 1 to 366 and -366 to -1. Negative values offs | ||||
et from the end of the year. The array MUST have at least one entry if included. | ||||
<vspace blankLines="1" /> | ||||
This is the BYYEARDAY part from iCalendar.</t> | ||||
<t>byWeekNo: <spanx style="verb">Int[]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
Weeks of the year in which to repeat. Valid values are between 1 and | ||||
the maximum number of weeks any year may have in the calendar given by the "rsc | ||||
ale" property, and the negative values of these numbers. For example, in the Gre | ||||
gorian calendar valid values are 1 to 53 and -53 to -1. The array MUST have at l | ||||
east one entry if included. | ||||
<vspace blankLines="1" /> | ||||
This is the BYWEEKNO part from iCalendar.</t> | ||||
<t>byHour: <spanx style="verb">UnsignedInt[]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The hours of the day in which to repeat. Valid values are 0 to 23. T | ||||
he array MUST have at least one entry if included. This is the BYHOUR part from | ||||
iCalendar.</t> | ||||
<t>byMinute: <spanx style="verb">UnsignedInt[]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The minutes of the hour in which to repeat. Valid values are 0 to 59 | ||||
. The array MUST have at least one entry if included. | ||||
<vspace blankLines="1" /> | ||||
This is the BYMINUTE part from iCalendar.</t> | ||||
<t>bySecond: <spanx style="verb">UnsignedInt[]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The seconds of the minute in which to repeat. Valid values are 0 to | ||||
60. The array MUST have at least one entry if included. | ||||
<vspace blankLines="1" /> | ||||
This is the BYSECOND part from iCalendar.</t> | ||||
<t>bySetPosition: <spanx style="verb">Int[]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The occurrences within the recurrence interval to include in the fin | ||||
al results. Negative values offset from the end of the list of occurrences. The | ||||
array MUST have at least one entry if included. This is the BYSETPOS part from i | ||||
Calendar.</t> | ||||
<t>count: <spanx style="verb">UnsignedInt</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The number of occurrences at which to range-bound the recurrence. Th | ||||
is MUST NOT be included if an <spanx style="verb">until</spanx> property is spec | ||||
ified. | ||||
<vspace blankLines="1" /> | ||||
This is the COUNT part from iCalendar.</t> | ||||
<t>until: <spanx style="verb">LocalDateTime</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The date-time at which to finish recurring. The last occurrence is o | ||||
n or before this date-time. This MUST NOT be included if a <spanx style="verb">c | ||||
ount</spanx> property is specified. Note: if not specified otherwise for a speci | ||||
fic JSCalendar object, this date is to be interpreted in the time zone specified | ||||
in the JSCalendar object's <spanx style="verb">timeZone</spanx> property. | ||||
<vspace blankLines="1" /> | ||||
This is the UNTIL part from iCalendar.</t> | ||||
</list></t> | ||||
<section anchor="recurrence-semantics" title="Interpreting recurrence | ||||
rules"> | ||||
<t>A recurrence rule specifies a set of date-times for recurring cal | ||||
endar objects. A recurrence rule has the following semantics. Note, wherever "ye | ||||
ar", "month" or "day of month" is used, this is within the calendar system given | ||||
by the "rscale" property, which defaults to "gregorian" if omitted. | ||||
<list style="numbers"> | ||||
<t>A set of candidates is generated. This is every second within a | ||||
period defined by the frequency property value: | ||||
<list style="symbols"> | ||||
<t><spanx style="verb">yearly</spanx>: every second from midnigh | ||||
t on the 1st day of a year (inclusive) to midnight the 1st day of the following | ||||
year (exclusive). | ||||
<vspace blankLines="1" /> | ||||
If skip is not "omit", the calendar system has leap months and t | ||||
here is a byMonth property, generate candidates for the leap months even if they | ||||
don't occur in this year. | ||||
<vspace blankLines="1" /> | ||||
If skip is not "omit" and there is a byMonthDay property, presum | ||||
e each month has the maximum number of days any month may have in this calendar | ||||
system when generating candidates, even if it's more than this month actually ha | ||||
s.</t> | ||||
<t><spanx style="verb">monthly</spanx>: every second from midnig | ||||
ht on the 1st day of a month (inclusive) to midnight on the 1st of the following | ||||
month (exclusive). | ||||
<vspace blankLines="1" /> | ||||
If skip is not "omit" and there is a byMonthDay property, presum | ||||
e the month has the maximum number of days any month may have in this calendar s | ||||
ystem when generating candidates, even if it's more than this month actually has | ||||
.</t> | ||||
<t><spanx style="verb">weekly</spanx>: every second from midnigh | ||||
t (inclusive) on the first day of the week (as defined by the firstDayOfWeek pro | ||||
perty, or Monday if omitted), to midnight 7 days later (exclusive).</t> | ||||
<t><spanx style="verb">daily</spanx>: every second from midnight | ||||
at the start of the day (inclusive) to midnight at the end of the day (exclusiv | ||||
e).</t> | ||||
<t><spanx style="verb">hourly</spanx>: every second from the beg | ||||
inning of the hour (inclusive) to the beginning of the next hour (exclusive).</t | ||||
> | ||||
<t><spanx style="verb">minutely</spanx>: every second from the b | ||||
eginning of the minute (inclusive) to the beginning of the next minute (exclusiv | ||||
e).</t> | ||||
<t><spanx style="verb">secondly</spanx>: the second itself, only | ||||
.</t> | ||||
</list></t> | ||||
<t>Each date-time candidate is compared against all of the byX pro | ||||
perties of the rule except bySetPosition. If any property in the rule does not m | ||||
atch the date-time, the date-time is eliminated. Each byX property is an array; | ||||
the date-time matches the property if it matches any of the values in the array. | ||||
The properties have the following semantics: | ||||
<list style="symbols"> | ||||
<t>byMonth: the date-time is in the given month.</t> | ||||
<t>byWeekNo: the date-time is in the nth week of the year. Negat | ||||
ive numbers mean the nth last week of the year. This corresponds to weeks accord | ||||
ing to week numbering as defined in ISO.8601.2004, with a week defined as a seve | ||||
n day period, starting on the firstDayOfWeek property value or Monday if omitted | ||||
. Week number one of the calendar year is the first week that contains at least | ||||
four days in that calendar year. | ||||
<vspace blankLines="1" /> | ||||
If the date-time is not valid (this may happen when generating c | ||||
andidates with a skip property in effect), it is always eliminated by this prope | ||||
rty.</t> | ||||
<t>byYearDay: the date-time is on the nth day of year. Negative | ||||
numbers mean the nth last day of the year. | ||||
<vspace blankLines="1" /> | ||||
If the date-time is not valid (this may happen when generating c | ||||
andidates with a skip property in effect), it is always eliminated by this prope | ||||
rty.</t> | ||||
<t>byMonthDay: the date-time is on the given day of the month. N | ||||
egative numbers mean the nth last day of the month.</t> | ||||
<t>byDay: the date-time is on the given day of the week. If the | ||||
day is prefixed by a number, it is the nth occurrence of that day of the week wi | ||||
thin the month (if frequency is monthly) or year (if frequency is yearly). Negat | ||||
ive numbers means nth last occurrence within that period.</t> | ||||
<t>byHour: the date-time has the given hour value.</t> | ||||
<t>byMinute: the date-time has the given minute value.</t> | ||||
<t>bySecond: the date-time has the given second value.</t> | ||||
</list> | ||||
If a skip property is defined and is not "omit", there may be cand | ||||
idates that do not correspond to valid dates (e.g., 31st February in the Gregori | ||||
an calendar). In this case, the properties MUST be considered in the order above | ||||
and: | ||||
<list style="numbers"> | ||||
<t>After applying the byMonth filter, if the candidate's month i | ||||
s invalid for the given year, increment it (if skip is "forward") or decrement i | ||||
t (if skip is "backward") until a valid month is found, incrementing/decrementin | ||||
g the year as well if passing through the beginning/end of the year. This only a | ||||
pplies to calendar systems with leap months.</t> | ||||
<t>After applying the byMonthDay filter, if the day of the month | ||||
is invalid for the given month and year, change the date to the first day of th | ||||
e next month (if skip is "forward") or the last day of the current month (if ski | ||||
p is "backward").</t> | ||||
<t>If any valid date produced after applying the skip is already | ||||
a candidate, eliminate the duplicate. (For example after adjusting, 30th Februa | ||||
ry and 31st February would both become the same "real" date, so one is eliminate | ||||
d as a duplicate.)</t> | ||||
</list> | ||||
</t> | ||||
<t>If a bySetPosition property is included, this is now applied to | ||||
the ordered list of remaining dates. This property specifies the indexes of dat | ||||
e-times to keep; all others should be eliminated. Negative numbers are indexes f | ||||
rom the end of the list, with -1 being the last item.</t> | ||||
<t>Any date-times before the start date of the event are eliminate | ||||
d (see below for why this might be needed).</t> | ||||
<t>If a skip property is included and is not "omit", eliminate any | ||||
date-times that have already been produced by previous iterations of the algori | ||||
thm. (This is not possible if skip is "omit".)</t> | ||||
<t>If further dates are required (we have not reached the until da | ||||
te, or count limit) skip the next (interval - 1) sets of candidates, then contin | ||||
ue from step 1.</t> | ||||
</list> | ||||
When determining the set of occurrence dates for an event or task, t | ||||
he following extra rules must be applied: | ||||
<list style="numbers"> | ||||
<t>The initial date-time to which the rule is applied (the <spanx | ||||
style="verb">start</spanx> date-time for events; the <spanx style="verb">start</ | ||||
spanx> or <spanx style="verb">due</spanx> date-time for tasks) is always the fir | ||||
st occurrence in the expansion (and is counted if the recurrence is limited by a | ||||
"count" property), even if it would normally not match the rule.</t> | ||||
<t>The first set of candidates to consider is that which would con | ||||
tain the initial date-time. This means the first set may include candidates befo | ||||
re the initial date-time; such candidates are eliminated from the results in ste | ||||
p (4) as outlined before.</t> | ||||
<t>The following properties MUST be implicitly added to the rule u | ||||
nder the given conditions: | ||||
<list style="symbols"> | ||||
<t>If frequency is not <spanx style="verb">secondly</spanx> and | ||||
no bySecond property: Add a bySecond property with the sole value being the seco | ||||
nds value of the initial date-time.</t> | ||||
<t>If frequency is not <spanx style="verb">secondly</spanx> or < | ||||
spanx style="verb">minutely</spanx>, and no byMinute property: Add a byMinute pr | ||||
operty with the sole value being the minutes value of the initial date-time.</t> | ||||
<t>If frequency is not <spanx style="verb">secondly</spanx>, <sp | ||||
anx style="verb">minutely</spanx> or <spanx style="verb">hourly</spanx> and no b | ||||
yHour property: Add a byHour property with the sole value being the hours value | ||||
of the initial date-time.</t> | ||||
<t>If frequency is <spanx style="verb">weekly</spanx> and no byD | ||||
ay property: Add a byDay property with the sole value being the day-of-the-week | ||||
of the initial date-time.</t> | ||||
<t>If frequency is <spanx style="verb">monthly</spanx> and no by | ||||
Day property and no byMonthDay property: Add a byMonthDay property with the sole | ||||
value being the day-of-the-month of the initial date-time.</t> | ||||
<t>If frequency is <spanx style="verb">yearly</spanx> and no byY | ||||
earDay property: | ||||
<list style="symbols"> | ||||
<t>If there are no byMonth or byWeekNo properties, and either | ||||
there is a byMonthDay property or there is no byDay property: Add a byMonth prop | ||||
erty with the sole value being the month of the initial date-time.</t> | ||||
<t>If there is no byMonthDay, byWeekNo or byDay properties: Ad | ||||
d a byMonthDay property with the sole value being the day-of-the-month of the in | ||||
itial date-time.</t> | ||||
<t>If there is a byWeekNo property and no byMonthDay or byDay | This means the first set may include candidates before the in | |||
properties: Add a byDay property with the sole value being the day-of-the-week o | itial date-time; such candidates are | |||
f the initial date-time.</t> | eliminated from the results in step 4 of the list above | |||
</list></t> | .</li> | |||
</list></t> | <li><t>The following properties <bcp14>MUST</bcp14> be implicitly | |||
</list></t> | added to the rule under the | |||
given conditions:</t> | ||||
<ul spacing="normal"> | ||||
<li>If frequency is not <tt>secondly</tt> and there is no <tt> | ||||
bySecond</tt> property, add a <tt>bySecond</tt> | ||||
property with the sole value being the seconds value of the i | ||||
nitial date-time.</li> | ||||
<li>If frequency is not <tt>secondly</tt> or <tt>minutely</tt> | ||||
and there is no <tt>byMinute</tt> | ||||
property, add a <tt>byMinute</tt> property with the sole valu | ||||
e being the minutes value of the initial | ||||
date-time.</li> | ||||
<li>If frequency is not <tt>secondly</tt>, <tt>minutely</tt>, | ||||
or <tt>hourly</tt> and there is | ||||
no <tt>byHour</tt> property, add a <tt>byHour</tt> property w | ||||
ith the sole value being the hours value of the | ||||
initial date-time.</li> | ||||
<li>If frequency is <tt>weekly</tt> and there is no <tt>byDay< | ||||
/tt> property, add a <tt>byDay</tt> property with | ||||
the sole value being the day of the week of the initial date- | ||||
time.</li> | ||||
<li>If frequency is <tt>monthly</tt> and there is no <tt>byDay | ||||
</tt> property and no <tt>byMonthDay</tt> | ||||
property, add a <tt>byMonthDay</tt> property with the sole va | ||||
lue being the day of the month of the | ||||
initial date-time.</li> | ||||
<li><t>If frequency is <tt>yearly</tt> and there is no <tt>byY | ||||
earDay</tt> property:</t> | ||||
<ul spacing="normal"> | ||||
<li>If there are no <tt>byMonth</tt> or <tt>byWeekNo</tt> | ||||
properties, and either there is a <tt>byMonthDay</tt> property or there is no <t | ||||
t>byDay</tt> property, add a <tt>byMonth</tt> property with the sole value being | ||||
the month of the initial date-time.</li> | ||||
<li>If there are no <tt>byMonthDay</tt>, <tt>byWeekNo</tt> | ||||
, or <tt>byDay</tt> properties, add a <tt>byMonthDay</tt> property with the sole | ||||
value being the day of the month of the initial date-time.</li> | ||||
<li>If there is a <tt>byWeekNo</tt> property and no <tt>by | ||||
MonthDay</tt> or <tt>byDay</tt> properties, add a <tt>byDay</tt> property with t | ||||
he sole value being the day of the week of the initial date-time.</li> | ||||
</ul> | ||||
</li> | ||||
</ul> | ||||
</li> | ||||
</ol> | ||||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="prop-excludedRecurrenceRules" numbered="true" toc="defa | ||||
<section anchor="prop-excludedRecurrenceRules" title="excludedRecurrence | ult"> | |||
Rules"> | <name>excludedRecurrenceRules</name> | |||
<t>Type: <spanx style="verb">RecurrenceRule[]</spanx> (optional).</t> | <t>Type: <tt>RecurrenceRule[]</tt> (optional)</t> | |||
<t>This defines a set of recurrence rules (repeating patterns) for dat | ||||
<t>Defines a set of recurrence rules (repeating patterns) for date-tim | e-times on which the object will not occur. The rules are interpreted the same a | |||
es on which the object will not occur. The rules are interpreted the same as for | s for the <tt>recurrenceRules</tt> property (see <xref target="prop-recurrenceRu | |||
the "recurrenceRules" property (see <xref target="prop-recurrenceRules" />), wi | les" format="default"/>), with the exception that the initial date-time to which | |||
th the exception that the initial date-time to which the rule is applied (the "s | the rule is applied (the "start" date-time for events or the "start" or "due" d | |||
tart" date-time for events; the "start" or "due" date-time for tasks) is only co | ate-time for tasks) is only considered part of the expansion if it matches the r | |||
nsidered part of the expansion if it matches the rule. The resulting set of date | ule. The resulting set of date-times is then removed from those generated by the | |||
-times are then removed from those generated by the recurrenceRules property, as | <tt>recurrenceRules</tt> property, as described in <xref target="recurrence-pro | |||
described in <xref target="recurrence-props" />. </t> | ps" format="default"/>. </t> | |||
</section> | </section> | |||
<section anchor="prop-recurrenceOverrides" numbered="true" toc="default" | ||||
<section anchor="prop-recurrenceOverrides" title="recurrenceOverrides"> | > | |||
<t>Type: <spanx style="verb">LocalDateTime[PatchObject]</spanx> (optio | <name>recurrenceOverrides</name> | |||
nal).</t> | <t>Type: <tt>LocalDateTime[PatchObject]</tt> (optional)</t> | |||
<t>Maps recurrence ids (the date-time produced by the recurrence rule) | ||||
<t>A map of the recurrence ids (the date-time produced by the recurren | to the overridden properties of the recurrence instance.</t> | |||
ce rule) to an object of patches to apply to the generated occurrence object.</t | ||||
> | ||||
<t>If the recurrence id does not match a date-time from the recurrence rule (or no rule is specified), it is to be treated as an additional occurrence (like an RDATE from iCalendar). The patch object may often be empty in this cas e.</t> | <t>If the recurrence id does not match a date-time from the recurrence rule (or no rule is specified), it is to be treated as an additional occurrence (like an RDATE from iCalendar). The patch object may often be empty in this cas e.</t> | |||
<t>If the patch object defines the <tt>excluded</tt> property of an oc | ||||
<t>If the patch object defines the <spanx style="verb">excluded</spanx | currence to be true, this occurrence is omitted from the final set of recurrence | |||
> property of an occurrence to be true, this occurrence is omitted from the fina | s for the calendar object (like an EXDATE from iCalendar). Such a patch object < | |||
l set of recurrences for the calendar object (like an EXDATE from iCalendar). Su | bcp14>MUST NOT</bcp14> patch any other property.</t> | |||
ch a patch object MUST NOT patch any other property.</t> | <t>By default, an occurrence inherits all properties from the main obj | |||
ect except the start (or due) date-time, which is shifted to match the recurrenc | ||||
<t>By default, an occurrence inherits all properties from the main obj | e id LocalDateTime. However, individual properties of the occurrence can be modi | |||
ect except the start (or due) date-time, which is shifted to match the recurrenc | fied by a patch or multiple patches. It is valid to patch the <tt>start</tt> pro | |||
e id LocalDateTime. However, individual properties of the occurrence can be modi | perty value, and this patch takes precedence over the value generated from the r | |||
fied by a patch, or multiple patches. It is valid to patch the <spanx style="ver | ecurrence id. Both the recurrence id as well as the patched <tt>start</tt> date- | |||
b">start</spanx> property value, and this patch takes precedence over the value | time may occur before the original JSCalendar object's <tt>start</tt> or <tt>due | |||
generated from the recurrence id. Both the recurrence id as well as the patched | </tt> date.</t> | |||
<spanx style="verb">start</spanx> date-time may occur before the original JSCale | <t>A pointer in the PatchObject <bcp14>MUST</bcp14> be ignored if it s | |||
ndar object's <spanx style="verb">start</spanx> or <spanx style="verb">due</span | tarts with one of the following | |||
x> date.</t> | prefixes:</t> | |||
<ul spacing="normal"> | ||||
<t>A pointer in the PatchObject MUST be ignored if it starts with one | <li>@type</li> | |||
of the following prefixes: | <li>excludedRecurrenceRules</li> | |||
<li>method</li> | ||||
<list style="symbols"> | <li>privacy</li> | |||
<t>@type</t> | <li>prodId</li> | |||
<t>excludedRecurrenceRules</t> | <li>recurrenceId</li> | |||
<t>method</t> | <li>recurrenceIdTimeZone</li> | |||
<t>privacy</t> | <li>recurrenceOverrides</li> | |||
<t>prodId</t> | <li>recurrenceRules</li> | |||
<t>recurrenceId</t> | <li>relatedTo</li> | |||
<t>recurrenceOverrides</t> | <li>replyTo</li> | |||
<t>recurrenceRules</t> | <li>sentBy</li> | |||
<t>relatedTo</t> | <li>timeZones</li> | |||
<t>replyTo</t> | <li>uid</li> | |||
<t>uid</t> | </ul> | |||
</list></t> | ||||
</section> | </section> | |||
<section anchor="prop-excluded" numbered="true" toc="default"> | ||||
<section anchor="prop-excluded" title="excluded"> | <name>excluded</name> | |||
<t>Type: <spanx style="verb">Boolean</spanx> (optional, default: false | <t>Type: <tt>Boolean</tt> (optional, default: false)</t> | |||
).</t> | <t>This defines if this object is an overridden, excluded instance of | |||
a recurring JSCalendar object (see <xref target="prop-recurrenceOverrides" forma | ||||
<t>Defines if this object is an overridden, excluded instance of a rec | t="default"/>). If this property value is true, this calendar object instance <b | |||
urring JSCalendar object (see <xref target="prop-recurrenceOverrides" />). If th | cp14>MUST</bcp14> be removed from the occurrence expansion. The absence of this | |||
is property value is true, this calendar object instance MUST be removed from th | property, or the presence of its default value as false, indicates that this ins | |||
e occurrence expansion. The absence of this property, or the presence of its def | tance <bcp14>MUST</bcp14> be included in the occurrence expansion.</t> | |||
ault value false, indicates that this instance MUST be included in the occurrenc | ||||
e expansion.</t> | ||||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="sharing-scheduling-properties" numbered="true" toc="defau | ||||
<section anchor="sharing-scheduling-properties" title="Sharing and Schedul | lt"> | |||
ing Properties"> | <name>Sharing and Scheduling Properties</name> | |||
<section anchor="prop-priority" title="priority"> | <section anchor="prop-priority" numbered="true" toc="default"> | |||
<t>Type: <spanx style="verb">Int</spanx> (optional, default: 0).</t> | <name>priority</name> | |||
<t>Type: <tt>Int</tt> (optional, default: 0)</t> | ||||
<t>Specifies a priority for the calendar object. This may be used as p | <t>This specifies a priority for the calendar object. This may be used | |||
art of scheduling systems to help resolve conflicts for a time period.</t> | as part of scheduling systems to help resolve conflicts for a time period.</t> | |||
<t>The priority is specified as an integer in the range 0 to 9. A valu e of 0 specifies an undefined priority, for which the treatment will vary by sit uation. A value of 1 is the highest priority. A value of 2 is the second highest priority. Subsequent numbers specify a decreasing ordinal priority. A value of 9 is the lowest priority. Other integer values are reserved for future use.</t> | <t>The priority is specified as an integer in the range 0 to 9. A valu e of 0 specifies an undefined priority, for which the treatment will vary by sit uation. A value of 1 is the highest priority. A value of 2 is the second highest priority. Subsequent numbers specify a decreasing ordinal priority. A value of 9 is the lowest priority. Other integer values are reserved for future use.</t> | |||
</section> | </section> | |||
<section anchor="prop-freeBusyStatus" numbered="true" toc="default"> | ||||
<section anchor="prop-freeBusyStatus" title="freeBusyStatus"> | <name>freeBusyStatus</name> | |||
<t>Type: <spanx style="verb">String</spanx> (optional, default: <spanx | <t>Type: <tt>String</tt> (optional, default: <tt>busy</tt>)</t> | |||
style="verb">busy</spanx>).</t> | <t>This specifies how this calendar object should be treated when calc | |||
<t>Specifies how this calendar object should be treated when calculati | ulating free-busy state. This <bcp14>MUST</bcp14> be one of the following values | |||
ng free-busy state. This MUST be one of the following values, another value regi | , another value registered in the IANA "JSCalendar Enum Values" regist | |||
stered in the IANA JSCalendar Enum Values registry, or a vendor-specific value ( | ry, or a vendor-specific value (see <xref target="custom-properties" format="def | |||
see <xref target="custom-properties" />): | ault"/>): | |||
</t> | ||||
<list style="symbols"> | <dl newline="false"> | |||
<t><spanx style="verb">free</spanx>: The object should be ignored wh | <dt><tt>free</tt>:</dt> | |||
en calculating whether the user is busy.</t> | <dd>The object should be ignored when calculating whether the use | |||
r is busy.</dd> | ||||
<t><spanx style="verb">busy</spanx>: The object should be included w | <dt><tt>busy</tt>:</dt> | |||
hen calculating whether the user is busy.</t> | <dd>The object should be included when calculating whether the us | |||
</list></t> | er is busy.</dd> | |||
</dl> | ||||
</section> | </section> | |||
<section anchor="prop-privacy" numbered="true" toc="default"> | ||||
<section anchor="prop-privacy" title="privacy"> | <name>privacy</name> | |||
<t>Type: <spanx style="verb">String</spanx> (optional, default: <spanx | <t>Type: <tt>String</tt> (optional, default: <tt>public</tt>)</t> | |||
style="verb">public</spanx>).</t> | <t>Calendar objects are normally collected together and may be shared | |||
with other users. The privacy property allows the object owner to indicate that | ||||
<t>Calendar objects are normally collected together and may be shared | it should not be shared or should only have the time information shared but the | |||
with other users. The privacy property allows the object owner to indicate that | details withheld. Enforcement of the restrictions indicated by this property is | |||
it should not be shared, or should only have the time information shared but the | up to the API via which this object is accessed.</t> | |||
details withheld. Enforcement of the restrictions indicated by this property ar | <t>This property <bcp14>MUST NOT</bcp14> affect the information sent t | |||
e up to the API via which this object is accessed.</t> | o scheduled participants; it is only interpreted by protocols that share the cal | |||
endar objects belonging to one user with other users.</t> | ||||
<t>This property MUST NOT affect the information sent to scheduled par | <t>The value <bcp14>MUST</bcp14> be one of the following values, anoth | |||
ticipants; it is only interpreted by protocols that share the calendar objects b | er value registered in the IANA "JSCalendar Enum Values" registry, or | |||
elonging to one user with other users.</t> | a vendor-specific value (see <xref target="custom-properties" format="default"/> | |||
). Any value the client or server doesn't understand should be preserved but tre | ||||
<t>The value MUST be one of the following values, another value regist | ated as equivalent to <tt>private</tt>.</t> | |||
ered in the IANA JSCalendar Enum Values registry, or a vendor-specific value (se | <dl newline="false" spacing="normal"> | |||
e <xref target="custom-properties" />). Any value the client or server doesn't u | <dt><tt>public</tt>:</dt> | |||
nderstand should be preserved but treated as equivalent to <spanx style="verb">p | <dd>The full details of the object are visible to those whom the | |||
rivate</spanx>. | object's calendar is shared | |||
with.</dd> | ||||
<list style="symbols"> | <dt><tt>private</tt>:</dt> | |||
<t><spanx style="verb">public</spanx>: The full details of the objec | <dd><t>The details of the object are hidden; only the basic time | |||
t are visible to those whom the object's calendar is shared with.</t> | and metadata are shared. The | |||
following properties <bcp14>MAY</bcp14> be shared; any other | ||||
<t><spanx style="verb">private</spanx>: The details of the object ar | properties <bcp14>MUST NOT</bcp14> be | |||
e hidden; only the basic time and metadata is shared. The following properties M | shared:</t> | |||
AY be shared, any other properties MUST NOT be shared: | <ul spacing="normal"> | |||
<li>@type</li> | ||||
<list style="symbols"> | <li>created</li> | |||
<t>@type</t> | <li>due</li> | |||
<t>created</t> | <li>duration</li> | |||
<t>due</t> | <li>estimatedDuration</li> | |||
<t>duration</t> | <li>freeBusyStatus</li> | |||
<t>estimatedDuration</t> | <li>privacy</li> | |||
<t>freeBusyStatus</t> | <li>recurrenceOverrides (Only patches that apply to another perm | |||
<t>privacy</t> | issible property are allowed to be shared.)</li> | |||
<t>recurrenceOverrides. Only patches which apply to another permis | <li>sequence</li> | |||
sible property are allowed to be shared.</t> | <li>showWithoutTime</li> | |||
<t>sequence</t> | <li>start</li> | |||
<t>showWithoutTime</t> | <li>timeZone</li> | |||
<t>start</t> | <li>timeZones</li> | |||
<t>timeZone</t> | <li>uid</li> | |||
<t>timeZones</t> | <li>updated</li> | |||
<t>uid</t> | </ul></dd> | |||
<t>updated</t> | <dt><tt>secret</tt>:</dt> | |||
</list></t> | <dd>The object is hidden completely (as though it did not exist) | |||
when the calendar this object is | ||||
<t><spanx style="verb">secret</spanx>: The object is hidden complete | in is shared.</dd> | |||
ly (as though it did not exist) when the calendar this object is in is shared.</ | </dl> | |||
t> | ||||
</list></t> | ||||
</section> | </section> | |||
<section anchor="prop-replyTo" numbered="true" toc="default"> | ||||
<section anchor="prop-replyTo" title="replyTo"> | <name>replyTo</name> | |||
<t>Type: <spanx style="verb">String[String]</spanx> (optional).</t> | <t>Type: <tt>String[String]</tt> (optional)</t> | |||
<t>This represents methods by which participants may submit their resp | ||||
<t>Represents methods by which participants may submit their response | onse to the organizer of the calendar object. The keys in the property value are | |||
to the organizer of the calendar object. The keys in the property value are the | the available methods and <bcp14>MUST</bcp14> only contain ASCII alphanumeric c | |||
available methods and MUST only contain ASCII alphanumeric characters (A-Za-z0-9 | haracters (A-Za-z0-9). The value is a URI for the method specified in the key. F | |||
). The value is a URI for the method specified in the key. Future methods may be | uture methods may be defined in future specifications and registered with IANA; | |||
defined in future specifications and registered with IANA; a calendar client MU | a calendar client <bcp14>MUST</bcp14> ignore any method it does not understand b | |||
ST ignore any method it does not understand, but MUST preserve the method key an | ut <bcp14>MUST</bcp14> preserve the method key and URI. This property <bcp14>MUS | |||
d URI. This property MUST be omitted if no method is defined (rather than being | T</bcp14> be omitted if no method is defined (rather than being specified as an | |||
specified as an empty object).</t> | empty object).</t> | |||
<t>The following methods are defined:</t> | ||||
<t>The following methods are defined: | <dl newline="false"> | |||
<dt><tt>imip</tt>:</dt> | ||||
<list style="symbols"> | <dd>The organizer accepts an iCalendar Message-Based Interoperabi | |||
<t><spanx style="verb">imip</spanx>: The organizer accepts an iMIP < | lity Protocol (iMIP) <xref | |||
xref target="RFC6047" /> response at this email address. The value MUST be a <sp | target="RFC6047" format="default"/> response at this email ad | |||
anx style="verb">mailto:</spanx> URI.</t> | dress. The value <bcp14>MUST</bcp14> | |||
be a <tt>mailto:</tt> URI.</dd> | ||||
<t><spanx style="verb">web</spanx>: Opening this URI in a web browse | <dt><tt>web</tt>:</dt> | |||
r will provide the user with a page where they can submit a reply to the organiz | <dd> Opening this URI in a web browser will provide the user with | |||
er. The value MUST be a URL using the <spanx style="verb">https:</spanx> scheme. | a page where they can submit a | |||
</t> | reply to the organizer. The value <bcp14>MUST</bcp14> be a UR | |||
L using the <tt>https:</tt> | ||||
<t><spanx style="verb">other</spanx>: The organizer is identified by | scheme.</dd> | |||
this URI but the method for submitting the response is undefined.</t> | <dt><tt>other</tt>:</dt> | |||
</list></t> | <dd> The organizer is identified by this URI, but the method for | |||
submitting the response is | ||||
undefined.</dd> | ||||
</dl> | ||||
</section> | </section> | |||
<section anchor="prop-sentBy" numbered="true" toc="default"> | ||||
<section anchor="prop-participants" title="participants"> | <name>sentBy</name> | |||
<t>Type: <spanx style="verb">Id[Participant]</spanx> (optional).</t> | <t>Type: <tt>String</tt> (optional)</t> | |||
<t>This is the email address in the "From" header of the email in whic | ||||
<t>A map of participant ids to participants, describing their particip | h this calendar object was received. This is only relevant if the calendar objec | |||
ation in the calendar object.</t> | t is received via iMIP or as an attachment to a message. If set, the value <bcp | |||
14>MUST</bcp14> be a valid <tt>addr-spec</tt> value as defined in Section 3.4.1 | ||||
<t>If this property is set and any participant has a sendTo property, | of <xref target="RFC5322" format="default"/>.</t> | |||
then the <spanx style="verb">replyTo</spanx> property of this calendar object MU | </section> | |||
ST define at least one reply method.</t> | <section anchor="prop-participants" numbered="true" toc="default"> | |||
<name>participants</name> | ||||
<t>Type: <tt>Id[Participant]</tt> (optional)</t> | ||||
<t>This is a map of participant ids to participants, describing their | ||||
participation in the calendar | ||||
object.</t> | ||||
<t>If this property is set and any participant has a <tt>sendTo</tt> p | ||||
roperty, then the <tt>replyTo</tt> | ||||
property of this calendar object <bcp14>MUST</bcp14> define at least | ||||
one reply method.</t> | ||||
<t>A Participant object has the following properties: | <t>A Participant object has the following properties: | |||
</t> | ||||
<list style="symbols"> | <dl newline="true"> | |||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | <dt>@type: <tt>String</tt> (mandatory)</dt> | |||
<vspace blankLines="1" /> | <dd>This specifies the type of this object. This <bcp14>MUST</bcp1 | |||
Specifies the type of this object. This MUST be <spanx style="verb"> | 4> be <tt>Participant</tt>.</dd> | |||
Participant</spanx>.</t> | <dt>name: <tt>String</tt> (optional)</dt> | |||
<dd>This is the display name of the participant (e.g., "Joe Bloggs | ||||
<t>name: <spanx style="verb">String</spanx> (optional) | ").</dd> | |||
<vspace blankLines="1" /> | <dt>email: <tt>String</tt> (optional)</dt> | |||
The display name of the participant (e.g., "Joe Bloggs").</t> | <dd>This is the email address to use to contact the participant or | |||
, for example, match with an address book entry. If set, the value <bcp14>MUST</ | ||||
<t>email: <spanx style="verb">String</spanx> (optional) | bcp14> be a valid <tt>addr-spec</tt> value as defined in Section 3.4.1 of <xref | |||
<vspace blankLines="1" /> | target="RFC5322" format="default"/>.</dd> | |||
The email address for the participant.</t> | <dt>description: <tt>String</tt> (optional)</dt> | |||
<dd>This is a plain-text description of this participant. For exam | ||||
<t>description: <spanx style="verb">String</spanx> (optional). | ple, this may include more | |||
<vspace blankLines="1" /> | information about their role in the event or how best to con | |||
A plain text description of this participant. For example, this may | tact them.</dd> | |||
include more information about their role in the event or how best to contact th | <dt>sendTo: <tt>String[String]</tt> (optional)</dt> | |||
em.</t> | <dd><t>This represents methods by which the participant may receiv | |||
e the invitation and updates to | ||||
<t>sendTo: <spanx style="verb">String[String]</spanx> (optional) | the calendar object.</t> | |||
<vspace blankLines="1" /> | <t>The keys in the property value are the available methods and <b | |||
Represents methods by which the participant may receive the invitati | cp14>MUST</bcp14> only contain | |||
on and updates to the calendar object. | ASCII alphanumeric characters (A-Za-z0-9). The value is a URI | |||
<vspace blankLines="1" /> | for the method specified in the | |||
The keys in the property value are the available methods and MUST on | key. Future methods may be defined in future specificat | |||
ly contain ASCII alphanumeric characters (A-Za-z0-9). The value is a URI for the | ions and registered with IANA; a calendar | |||
method specified in the key. Future methods may be defined in future specificat | client <bcp14>MUST</bcp14> ignore any method it d | |||
ions and registered with IANA; a calendar client MUST ignore any method it does | oes not understand but <bcp14>MUST</bcp14> | |||
not understand, but MUST preserve the method key and URI. This property MUST be | preserve the method key and URI. This prope | |||
omitted if no method is defined (rather than being specified as an empty object) | rty <bcp14>MUST</bcp14> be omitted if no method is | |||
. | defined (rather than being specified | |||
<vspace blankLines="1" /> | as an empty object).</t> | |||
The following methods are defined: | <t>The following methods are defined:</t> | |||
<list style="symbols"> | <dl> | |||
<t><spanx style="verb">imip</spanx>: The participant accepts an iM | <dt><tt>imip</tt>:</dt> | |||
IP <xref target="RFC6047" /> request at this email address. The value MUST be a | <dd>The participant accepts an iMIP <xref target="RFC6047" | |||
<spanx style="verb">mailto:</spanx> URI. It MAY be different from the value of t | format="default"/> request at this email address. The value <bcp1 | |||
he participant's <spanx style="verb">email</spanx> property.</t> | 4>MUST</bcp14> be a | |||
<tt>mailto:</tt> URI. It <bcp14>MAY</bcp14> be different from the | ||||
<t><spanx style="verb">other</spanx>: The participant is identifie | value of the participant's | |||
d by this URI but the method for submitting the invitation is undefined.</t> | <tt>email</tt> property.</dd> | |||
</list></t> | <dt><tt>other</tt>:</dt> | |||
<dd>The participant is identified by this URI, but the method for | ||||
<t>kind: <spanx style="verb">String</spanx> (optional) | submitting the invitation is | |||
<vspace blankLines="1" /> | undefined.</dd> | |||
What kind of entity this participant is, if known. | </dl></dd> | |||
<vspace blankLines="1" /> | <dt>kind: <tt>String</tt> (optional)</dt> | |||
This MUST be one of the following values, another value registered i | <dd><t>This is what kind of entity this participant is, if known.< | |||
n the IANA JSCalendar Enum Values registry, or a vendor-specific value (see <xre | /t> | |||
f target="custom-properties" />). Any value the client or server doesn't underst | <t>This <bcp14>MUST</bcp14> be one of the following values, anothe | |||
and should be treated the same as if this property is omitted. | r value registered in the IANA | |||
"JSCalendar Enum Values" registry, or a vendor-spec | ||||
<list style="symbols"> | ific value (see <xref target="custom-properties" | |||
<t><spanx style="verb">individual</spanx>: a single person</t> | format="default"/>). Any value the client or server doe | |||
sn't understand should be treated the same | ||||
<t><spanx style="verb">group</spanx>: a collection of people invit | as if this property is omitted.</t> | |||
ed as a whole</t> | <dl newline="false"> | |||
<dt><tt>individual</tt>:</dt> | ||||
<t><spanx style="verb">location</spanx>: a physical location that | <dd> a single person</dd> | |||
needs to be scheduled, e.g., a conference room</t> | <dt><tt>group</tt>:</dt> | |||
<dd>a collection of people invited as a whole</dd> | ||||
<t><spanx style="verb">resource</spanx>: a non-human resource othe | <dt><tt>location</tt>:</dt> | |||
r than a location, such as a projector</t> | <dd> a physical location that needs to be scheduled, e.g., a conf | |||
</list></t> | erence room</dd> | |||
<dt><tt>resource</tt>:</dt> | ||||
<t>roles: <spanx style="verb">String[Boolean]</spanx> (mandatory) | <dd>a non-human resource other than a location, such as a project | |||
<vspace blankLines="1" /> | or</dd> | |||
A set of roles that this participant fulfills. | </dl></dd> | |||
<vspace blankLines="1" /> | <dt>roles: <tt>String[Boolean]</tt> (mandatory)</dt> | |||
At least one role MUST be specified for the participant. The keys in | <dd><t>This is a set of roles that this participant fulfills.</t> | |||
the set MUST be one of the following values, another value registered in the IA | <t>At least one role <bcp14>MUST</bcp14> be specified for the part | |||
NA JSCalendar Enum Values registry, or a vendor-specific value (see <xref target | icipant. The keys in the set | |||
="custom-properties" />): | <bcp14>MUST</bcp14> be one of the following values, another v | |||
alue registered in the IANA | ||||
<list style="symbols"> | "JSCalendar Enum Values" registry, or a vendo | |||
<t><spanx style="verb">owner</spanx>: The participant is an owner | r-specific value (see <xref target="custom-properties" | |||
of the object. This signifies they have permission to make changes to it that af | format="default"/>):</t> | |||
fect the other participants. Non-owner participants may only change properties t | <dl> | |||
hat just affect themselves (for example setting their own alerts or changing the | <dt><tt>owner</tt>:</dt> | |||
ir rsvp status).</t> | <dd> The participant is an owner of the object. This signifies th | |||
<t><spanx style="verb">attendee</spanx>: The participant is expect | ey have permission to make | |||
ed to be present at the event.</t> | changes to it that affect the other participants. Nonowner partic | |||
<t><spanx style="verb">optional</spanx>: The participant's involve | ipants may only change | |||
ment with the event is optional. This is expected to be primarily combined with | properties that affect only themselves (for example, setting thei | |||
the "attendee" role.</t> | r own alerts or changing their | |||
<t><spanx style="verb">informational</spanx>: The participant is c | RSVP status).</dd> | |||
opied for informational reasons, and is not expected to attend.</t> | <dt><tt>attendee</tt>:</dt> | |||
<t><spanx style="verb">chair</spanx>: The participant is in charge | <dd>The participant is expected to be present at the event.</dd> | |||
of the event/task when it occurs.</t> | <dt><tt>optional</tt>:</dt> | |||
<t><spanx style="verb">contact</spanx>: The participant is someone | <dd>The participant's involvement with the event is optional. Thi | |||
that may be contacted for information about the event.</t> | s is expected to be primarily | |||
</list> | combined with the "attendee" role.</dd> | |||
<dt><tt>informational</tt>:</dt> | ||||
The value for each key in the map MUST be true. It is expected that | <dd> The participant is copied for informational reasons and is n | |||
no more than one of the roles "attendee" and "informational" be present; if more | ot expected to attend.</dd> | |||
than one are given, "attendee" takes precedence over "informational". Roles tha | <dt><tt>chair</tt>:</dt> | |||
t are unknown to the implementation MUST be preserved.</t> | <dd> The participant is in charge of the event/task when it occur | |||
s.</dd> | ||||
<t>locationId: <spanx style="verb">String</spanx> (optional) | <dt><tt>contact</tt>:</dt> | |||
<vspace blankLines="1" /> | <dd> The participant is someone that may be contacted for informa | |||
The location at which this participant is expected to be attending. | tion about the event.</dd> | |||
<vspace blankLines="1" /> | </dl> | |||
If the value does not correspond to any location id in the | <t>The value for each key in the map <bcp14>MUST</bcp14> be true. | |||
<spanx style="verb">locations</spanx> property of the JSCalendar obj | It is expected that no more | |||
ect, this MUST be treated the same as if the participant's locationId were omitt | than one of the roles "attendee" and "informational" be present | |||
ed.</t> | ; if more than one are given, | |||
"attendee" takes precedence over "informational". Roles tha | ||||
<t>language: <spanx style="verb">String</spanx> (optional) | t are unknown to the implementation | |||
<vspace blankLines="1" /> | <bcp14>MUST</bcp14> be preserved.</t></dd> | |||
The language tag as defined in <xref target="RFC5646" /> that best d | <dt>locationId: <tt>Id</tt> (optional)</dt> | |||
escribes the participant's preferred language, if known.</t> | <dd><t>This is the location at which this participant is expected | |||
to be attending.</t> | ||||
<t>participationStatus: <spanx style="verb">String</spanx> (optional | <t>If the value does not correspond to any location id in the <tt> | |||
, default: <spanx style="verb">needs-action</spanx>) | locations</tt> property of the | |||
<vspace blankLines="1" /> | JSCalendar object, this <bcp14>MUST</bcp14> be treated the sa | |||
The participation status, if any, of this participant. | me as if the participant's | |||
<vspace blankLines="1" /> | locationId were omitted.</t></dd> | |||
The value MUST be one of the following values, another value registe | <dt>language: <tt>String</tt> (optional)</dt> | |||
red in the IANA JSCalendar Enum Values registry, or a vendor-specific value (see | <dd>This is the language tag, as defined in <xref target="BCP47" f | |||
<xref target="custom-properties" />): | ormat="default"/>, that best | |||
describes | ||||
<list style="symbols"> | the participant's preferred language, if known.</dd> | |||
<t><spanx style="verb">needs-action</spanx>: No status yet set by | <dt>participationStatus: <tt>String</tt> (optional, default: <tt>n | |||
the participant.</t> | eeds-action</tt>)</dt> | |||
<dd><t>This is the participation status, if any, of this part | ||||
<t><spanx style="verb">accepted</spanx>: The invited participant w | icipant.</t> | |||
ill participate.</t> | <t>The value <bcp14>MUST</bcp14> be one of the following values, a | |||
nother value registered in the | ||||
<t><spanx style="verb">declined</spanx>: The invited participant w | IANA "JSCalendar Enum Values" registry, or a vendor | |||
ill not participate.</t> | -specific value (see <xref | |||
target="custom-properties" format="default"/>):</t> | ||||
<t><spanx style="verb">tentative</spanx>: The invited participant | <dl newline="false"> | |||
may participate.</t> | <dt><tt>needs-action</tt>:</dt> | |||
<dd> No status has yet been set by the participant.</dd> | ||||
<t><spanx style="verb">delegated</spanx>: The invited participant | <dt><tt>accepted</tt>:</dt> | |||
has delegated their attendance to another participant, as specified in the deleg | <dd> The invited participant will participate.</dd> | |||
atedTo property.</t> | <dt><tt>declined</tt>:</dt> | |||
</list></t> | <dd>The invited participant will not participate.</dd> | |||
<dt><tt>tentative</tt>:</dt> | ||||
<t>participationComment: <spanx style="verb">String</spanx> (optiona | <dd> The invited participant may participate.</dd> | |||
l) | <dt><tt>delegated</tt>:</dt> | |||
<vspace blankLines="1" /> | <dd> The invited participant has delegated their attendance to an | |||
A note from the participant to explain their participation status.</ | other participant, as | |||
t> | specified in the <tt>delegatedTo</tt> property.</dd> | |||
</dl></dd> | ||||
<t>expectReply: <spanx style="verb">Boolean</spanx> (optional, defau | <dt>participationComment: <tt>String</tt> (optional)</dt> | |||
lt: false) | <dd>This is a note from the participant to explain their particip | |||
<vspace blankLines="1" /> | ation status.</dd> | |||
If true, the organizer is expecting the participant to notify them o | <dt>expectReply: <tt>Boolean</tt> (optional, default: false)</dt> | |||
f their participation status.</t> | <dd>If true, the organizer is expecting the participant to notify | |||
them of their participation | ||||
<t>scheduleAgent: <spanx style="verb">String</spanx> (optional, defa | status.</dd> | |||
ult: <spanx style="verb">server</spanx>) | <dt>scheduleAgent: <tt>String</tt> (optional, default: <tt>server< | |||
<vspace blankLines="1" /> | /tt>)</dt><dd> | |||
Who is responsible for sending scheduling messages with this calenda | <t>This is who is responsible for sending scheduling messages with | |||
r object to the participant. | this calendar object to the | |||
<vspace blankLines="1" /> | participant.</t> | |||
The value MUST be one of the following values, another value registe | <t>The value <bcp14>MUST</bcp14> be one of the following values, a | |||
red in the IANA JSCalendar Enum Values registry, or a vendor-specific value (see | nother value registered in the | |||
<xref target="custom-properties" />): | IANA "JSCalendar Enum Values" registry, or a vendor | |||
-specific value (see <xref | ||||
<list style="symbols"> | target="custom-properties" format="default"/>):</t> | |||
<t><spanx style="verb">server</spanx>: The calendar server will se | <dl spacing="normal"> | |||
nd the scheduling messages.</t> | <dt><tt>server</tt>:</dt> | |||
<dd> The calendar server will send the scheduling messages.</dd> | ||||
<t><spanx style="verb">client</spanx>: The calendar client will se | <dt><tt>client</tt>:</dt> | |||
nd the scheduling messages.</t> | <dd> The calendar client will send the scheduling messages.</dd> | |||
<dt><tt>none</tt>:</dt> | ||||
<t><spanx style="verb">none</spanx>: No scheduling messages are to | <dd> No scheduling messages are to be sent to this participant.</ | |||
be sent to this participant.</t> | dd> | |||
</list></t> | </dl></dd> | |||
<dt>scheduleForceSend: <tt>Boolean</tt> (optional, default: false) | ||||
<t>scheduleForceSend: <spanx style="verb">Boolean</spanx> (optional, | </dt> | |||
default: false) | <dd>A client may set the property on a participant to true to requ | |||
<vspace blankLines="1" /> | est that the server send a | |||
A client may set the property on a participant to true to request th | scheduling message to the participant when it would not norma | |||
at the server send a scheduling message to the participant when it would not nor | lly do so (e.g., if no significant | |||
mally do so (e.g. if no significant change is made the object or the scheduleAge | change is made the object or the scheduleAgent is set t | |||
nt is set to client). The property MUST NOT be stored in the JSCalendar object o | o client). The property <bcp14>MUST | |||
n the server or appear in a scheduling message.</t> | NOT</bcp14> be stored in the JSCalendar object on | |||
the server or appear in a scheduling | ||||
<t>scheduleSequence: <spanx style="verb">UnsignedInt</spanx> (option | message.</dd> | |||
al, default: 0) | <dt>scheduleSequence: <tt>UnsignedInt</tt> (optional, default: 0)< | |||
<vspace blankLines="1" /> | /dt> | |||
The sequence number of the last response from the participant. If de | <dd><t>This is the sequence number of the last response from the p | |||
fined, this MUST be a non-negative integer. | articipant. If defined, this | |||
<vspace blankLines="1" /> | <bcp14>MUST</bcp14> be a nonnegative integer.</t> | |||
This can be used to determine whether the participant has sent a new | <t>This can be used to determine whether the participant has sent | |||
response following significant changes to the calendar object, and to determine | a new response following | |||
if future responses are responding to a current or older view of the data.</t> | significant changes to the calendar object and to determine i | |||
f future responses are responding | ||||
<t>scheduleStatus: <spanx style="verb">String[]</spanx> (optional) | to a current or older view of the data.</t></dd> | |||
<vspace blankLines="1" /> | <dt>scheduleStatus: <tt>String[]</tt> (optional)</dt> | |||
A list of status codes, as defined in Section 3.8.8.3 of <xref targe | <dd><t>This is a list of status codes, returned from the processin | |||
t="RFC5545" />, returned from the processing of the most recent scheduling messa | g of the most recent scheduling message sent to this participant. The status cod | |||
ge sent to this participant. | es MUST be valid <tt>statcode</tt> values as defined in the ABNF in <xref target | |||
<vspace blankLines="1" /> | ="RFC5545" sectionFormat="of" section="3.8.8.3"/>.</t> | |||
Servers MUST only add or change this property when they send a sched | <t>Servers <bcp14>MUST</bcp14> only add or change this property wh | |||
uling message to the participant. Clients SHOULD NOT change or remove this prope | en they send a scheduling | |||
rty if it was provided by the server. Clients MAY add, change, or remove the pro | message to the participant. Clients <bcp14>SHOULD NOT</bcp14> | |||
perty for participants where the client is handling the scheduling. | change or remove this property if | |||
<vspace blankLines="1" /> | it was provided by the server. Clients <bcp14>MAY</bcp1 | |||
This property MUST NOT be included in scheduling messages.</t> | 4> add, change, or remove the property for | |||
participants where the client is handling the sch | ||||
<t>scheduleUpdated: <spanx style="verb">UTCDateTime</spanx> (optiona | eduling.</t> | |||
l) | <t>This property <bcp14>MUST NOT</bcp14> be included in scheduling | |||
<vspace blankLines="1" /> | messages.</t> | |||
The timestamp for the most recent response from this participant. | </dd> | |||
<vspace blankLines="1" /> | <dt>scheduleUpdated: <tt>UTCDateTime</tt> (optional)</dt> | |||
This is the <spanx style="verb">updated</spanx> property of the last | <dd><t>This is the timestamp for the most recent response from thi | |||
response when using iTIP. It can be compared to the <spanx style="verb">updated | s participant.</t> | |||
</spanx> property in future responses to detect and discard older responses deli | <t>This is the <tt>updated</tt> property of the last response when | |||
vered out of order.</t> | using iTIP. It can be compared | |||
to the <tt>updated</tt> property in future responses to detec | ||||
<t>invitedBy: <spanx style="verb">String</spanx> (optional) | t and discard older responses | |||
<vspace blankLines="1" /> | delivered out of order.</t></dd> | |||
The participant id of the participant who invited this one, if known | <dt>sentBy: <tt>String</tt> (optional)</dt> | |||
.</t> | <dd><t>This is the email address in the "From" header of the email | |||
that last updated this participant via iMIP. This SHOULD only be set if the ema | ||||
<t>delegatedTo: <spanx style="verb">String[Boolean]</spanx> (optiona | il address is different to that in the mailto URI of this participant's <tt>imip | |||
l) | </tt> method in the <tt>sendTo</tt> property (i.e., the response was received fr | |||
<vspace blankLines="1" /> | om a different address to that which the invitation was sent to). If set, the va | |||
A set of participant ids that this participant has delegated their p | lue <bcp14>MUST</bcp14> be a valid <tt>addr-spec</tt> value as defined in Sectio | |||
articipation to. Each key in the set MUST be the id of a participant. The value | n 3.4.1 of <xref target="RFC5322" format="default"/>.</t> | |||
for each key in the map MUST be true. If there are no delegates, this MUST be om | </dd> | |||
itted (rather than specified as an empty set).</t> | <dt>invitedBy: <tt>Id</tt> (optional)</dt> | |||
<dd>This is the id of the participant who added this particip | ||||
<t>delegatedFrom: <spanx style="verb">String[Boolean]</spanx> (optio | ant to the event/task, if known.</dd> | |||
nal) | <dt>delegatedTo: <tt>Id[Boolean]</tt> (optional)</dt> | |||
<vspace blankLines="1" /> | <dd>This is set of participant ids that this participant has | |||
A set of participant ids that this participant is acting as a delega | delegated their participation to. | |||
te for. Each key in the set MUST be the id of a participant. The value for each | Each key | |||
key in the map MUST be true. If there are no delegators, this MUST be omitted (r | in the set <bcp14>MUST</bcp14> be the id of a par | |||
ather than specified as an empty set).</t> | ticipant. The value for each key in the map | |||
<bcp14>MUST</bcp14> be true. If there are n | ||||
<t>memberOf: <spanx style="verb">String[Boolean]</spanx> (optional) | o delegates, this <bcp14>MUST</bcp14> be omitted | |||
<vspace blankLines="1" /> | (rather than specified as an empty se | |||
A set of group participants that were invited to this calendar objec | t).</dd> | |||
t, which caused this participant to be invited due to their membership in the gr | <dt>delegatedFrom: <tt>Id[Boolean]</tt> (optional)</dt> | |||
oup(s). Each key in the set MUST be the id of a participant. The value for each | <dd>This is a set of participant ids that this participant is acti | |||
key in the map MUST be true. If there are no groups, this MUST be omitted (rathe | ng as a delegate for. Each key | |||
r than specified as an empty set).</t> | in the set <bcp14>MUST</bcp14> be the id of a participant. Th | |||
e value for each key in the map | ||||
<t>links: <spanx style="verb">Id[Link]</spanx> (optional) | <bcp14>MUST</bcp14> be true. If there are no delegators | |||
<vspace blankLines="1" /> | , this <bcp14>MUST</bcp14> be omitted | |||
A map of link ids to Link objects, representing external resources a | (rather than specified as an empty set).</dd> | |||
ssociated with this participant, for example a vCard or image. | <dt>memberOf: <tt>Id[Boolean]</tt> (optional)</dt> | |||
If there are no links, this MUST be omitted (rather than specified a | <dd>This is a set of group participants that were invited to this | |||
s an empty set).</t> | calendar object, which caused | |||
this | ||||
<t>progress: <spanx style="verb">String</spanx> (optional; only all | participant to be invited due to their membership in th | |||
owed for participants of a JSTask). Represents the progress of the participant f | e group(s). Each key in the set | |||
or this task. It MUST NOT be set if the <spanx style="verb">participationStatus< | <bcp14>MUST</bcp14> be the id of a participant. T | |||
/spanx> of this participant is any value other than <spanx style="verb">accepted | he value for each key in the map | |||
</spanx>. See <xref target="prop-progress" /> for allowed values and semantics.< | <bcp14>MUST</bcp14> be true. If there are n | |||
/t> | o groups, this <bcp14>MUST</bcp14> be omitted (rather | |||
than specified as an empty set).</dd> | ||||
<t>progressUpdated: <spanx style="verb">UTCDateTime</spanx> (optiona | <dt>links: <tt>Id[Link]</tt> (optional)</dt> | |||
l; only allowed for participants of a JSTask). Specifies the date-time the progr | <dd>This is a map of link ids to Link objects, representing extern | |||
ess property was last set on this participant. See <xref target="prop-progressUp | al resources associated with | |||
dated" /> for allowed values and semantics.</t> | this participant, for example, a vCard or image. If there are | |||
no links, this <bcp14>MUST</bcp14> | ||||
<t>percentComplete: <spanx style="verb">UnsignedInt</spanx> (optiona | be omitted (rather than specified as an empty set).</dd | |||
l; only allowed for participants of a JSTask). Represents the percent completion | > | |||
of the participant for this task. The property value MUST be a positive integer | <dt>progress: <tt>String</tt> (optional; only allowed for participan | |||
between 0 and 100.</t> | ts of a Task)</dt> | |||
</list></t> | <dd>This represents the progress of the participant for this task | |||
. It <bcp14>MUST NOT</bcp14> be | ||||
set if | ||||
the <tt>participationStatus</tt> of this participant is a | ||||
ny value other than <tt>accepted</tt>. See | ||||
<xref target="prop-progress" format="default"/> for a | ||||
llowed values and semantics.</dd> | ||||
<dt>progressUpdated: <tt>UTCDateTime</tt> (optional; only allowed fo | ||||
r participants of a | ||||
Task)</dt> | ||||
<dd>This specifies the date-time the <tt>progress</tt> proper | ||||
ty was last set on this participant. See <xref target="prop-progressUpdated" for | ||||
mat="default"/> for allowed values and semantics.</dd> | ||||
<dt>percentComplete: <tt>UnsignedInt</tt> (optional; only allowed fo | ||||
r participants of a Task)</dt> | ||||
<dd>This represents the percent completion of the participant for | ||||
this task. The property value <bcp14>MUST</bcp14> be a positive integer between | ||||
0 and 100.</dd> | ||||
</dl> | ||||
</section> | ||||
<section anchor="prop-requestStatus" numbered="true" toc="default"> | ||||
<name>requestStatus</name> | ||||
<t>Type: <tt>String</tt> (optional)</t> | ||||
<t>A request status as returned from processing the most recent schedu | ||||
ling request for this JSCalendar object. The allowed values are defined by the A | ||||
BNF definitions of <tt>statcode</tt>, <tt>statdesc</tt> and <tt>extdata</tt> in | ||||
<xref target="RFC5545" sectionFormat="of" section="3.8.8.3"/> and the following | ||||
ABNF <xref target="RFC5234" />:</t> | ||||
<sourcecode name="" type="abnf"><![CDATA[ | ||||
reqstatus = statcode ";" statdesc [";" extdata] | ||||
]]></sourcecode> | ||||
<t>Servers <bcp14>MUST</bcp14> only add or change this property when t | ||||
hey performe a scheduling action. Clients <bcp14>SHOULD NOT</bcp14> change or re | ||||
move this property if it was provided by the server. Clients <bcp14>MAY</bcp14> | ||||
add, change, or remove the property when the client is handling the scheduling.< | ||||
/t> | ||||
<t>This property <bcp14>MUST</bcp14> only be included in scheduling me | ||||
ssages according to the rules defined for the REQUEST-STATUS iCalendar property | ||||
in <xref target="RFC5546" format="default"/>.</t> | ||||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="alerts-properties" numbered="true" toc="default"> | ||||
<section anchor="alerts-properties" title="Alerts Properties"> | <name>Alerts Properties</name> | |||
<section anchor="useDefaultAlerts" title="useDefaultAlerts"> | <section anchor="useDefaultAlerts" numbered="true" toc="default"> | |||
<t>Type: <spanx style="verb">Boolean</spanx> (optional, default: false | <name>useDefaultAlerts</name> | |||
).</t> | <t>Type: <tt>Boolean</tt> (optional, default: false)</t> | |||
<t>If true, use the user's default alerts and ignore the value of the | ||||
<t>If true, use the user's default alerts and ignore the value of the | <tt>alerts</tt> property. Fetching user defaults is dependent on the API from wh | |||
<spanx style="verb">alerts</spanx> property. Fetching user defaults is dependent | ich this JSCalendar object is being fetched and is not defined in this specifica | |||
on the API from which this JSCalendar object is being fetched, and is not defin | tion. If an implementation cannot determine the user's default alerts, or none a | |||
ed in this specification. If an implementation cannot determine the user's defau | re set, it <bcp14>MUST</bcp14> process the <tt>alerts</tt> property as if <tt>us | |||
lt alerts, or none are set, it MUST process the alerts property as if <spanx sty | eDefaultAlerts</tt> is set to false.</t> | |||
le="verb">useDefaultAlerts</spanx> is set to false.</t> | ||||
</section> | ||||
<section anchor="prop-alerts" title="alerts"> | ||||
<t>Type: <spanx style="verb">Id[Alert]</spanx> (optional).</t> | ||||
<t>A map of alert ids to Alert objects, representing alerts/reminders | ||||
to display or send to the user for this calendar object.</t> | ||||
<t>An Alert Object has the following properties: | ||||
<list style="symbols"> | ||||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | ||||
<vspace blankLines="1" /> | ||||
Specifies the type of this object. This MUST be <spanx style="verb"> | ||||
Alert</spanx>. | ||||
</t> | ||||
<t>trigger: <spanx style="verb">OffsetTrigger|AbsoluteTrigger|Unknow | ||||
nTrigger</spanx> (mandatory) | ||||
<vspace blankLines="1" /> | ||||
Defines when to trigger the alert. New types may be defined in futur | ||||
e documents. | ||||
<vspace blankLines="1" /> | ||||
An <spanx style="verb">OffsetTrigger</spanx> object has the followin | ||||
g properties: | ||||
<list style="symbols"> | ||||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | ||||
<vspace blankLines="1" /> | ||||
Specifies the type of this object. This MUST be <spanx style="verb | ||||
">OffsetTrigger</spanx>. | ||||
</t> | ||||
<t>offset: <spanx style="verb">SignedDuration</spanx> (mandatory). | ||||
<vspace blankLines="1" /> | ||||
Defines the offset at which to trigger the alert relative to the t | ||||
ime property defined in the <spanx style="verb">relativeTo</spanx> property of t | ||||
he alert. Negative durations signify alerts before the time property, positive d | ||||
urations signify alerts after.</t> | ||||
<t>relativeTo: <spanx style="verb">String</spanx> (optional, defau | ||||
lt: <spanx style="verb">start</spanx>) | ||||
<vspace blankLines="1" /> | ||||
Specifies the time property that the alert offset is relative to. | ||||
The value MUST be one of: | ||||
<list style="symbols"> | ||||
<t><spanx style="verb">start</spanx>: triggers the alert relativ | ||||
e to the start of the calendar object</t> | ||||
<t><spanx style="verb">end</spanx>: triggers the alert relative | ||||
to the end/due time of the calendar object</t> | ||||
</list></t> | ||||
</list> | ||||
An <spanx style="verb">AbsoluteTrigger</spanx> object has the follow | ||||
ing properties: | ||||
<list style="symbols"> | ||||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | ||||
<vspace blankLines="1" /> | ||||
Specifies the type of this object. This MUST be <spanx style="verb | ||||
">AbsoluteTrigger</spanx>. | ||||
</t> | ||||
<t>when: <spanx style="verb">UTCDateTime</spanx> (mandatory). | ||||
<vspace blankLines="1" /> | ||||
Defines a specific UTC date-time when the alert is triggered.</t> | ||||
</list> | ||||
An <spanx style="verb">UnknownTrigger</spanx> object is an object th | ||||
at contains a <spanx style="verb">@type</spanx> property whose value is not reco | ||||
gnized (i.e., not <spanx style="verb">OffsetTrigger</spanx> or <spanx style="ver | ||||
b">AbsoluteTrigger</spanx>), plus zero or more other properties. This is for com | ||||
patibility with client extensions and future specifications. Implementations SHO | ||||
ULD NOT trigger for trigger types they do not understand, but MUST preserve them | ||||
.</t> | ||||
<t>acknowledged: <spanx style="verb">UTCDateTime</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
This records when an alert was last acknowledged. This is set when t | ||||
he user has dismissed the alert; other clients that sync this property SHOULD au | ||||
tomatically dismiss or suppress duplicate alerts (alerts with the same alert id | ||||
that triggered on or before this date-time). | ||||
<vspace blankLines="1" /> | ||||
For a recurring calendar object, setting the <spanx style="verb">ack | ||||
nowledged</spanx> property MUST NOT add a new override to the <spanx style="verb | ||||
">recurrenceOverrides</spanx> property. If the alert is not already overridden, | ||||
the acknowledged property MUST be set on the alert in the master event/task. | ||||
<vspace blankLines="1" /> | ||||
Certain kinds of alert action may not provide feedback as to when th | ||||
e user sees them, for example email based alerts. For those kinds of alerts, thi | ||||
s property MUST be set immediately when the alert is triggered and the action su | ||||
ccessfully carried out.</t> | ||||
<t>relatedTo: <spanx style="verb">String[Relation]</spanx> (optional | ||||
) | ||||
<vspace blankLines="1" /> | ||||
Relates this alert to other alerts in the same JSCalendar object. If | ||||
the user wishes to snooze an alert, the application MUST create an alert to tri | ||||
gger after snoozing. This new snooze alert MUST set a parent relation to the ide | ||||
ntifier of the original alert.</t> | ||||
<t>action: <spanx style="verb">String</spanx> (optional, default: <s | ||||
panx style="verb">display</spanx>) | ||||
<vspace blankLines="1" /> | ||||
Describes how to alert the user. | ||||
<vspace blankLines="1" /> | ||||
The value MUST be at most one of the following values, a value regis | ||||
tered in the IANA JSCalendar Enum Values registry, or a vendor-specific value (s | ||||
ee <xref target="custom-properties" />): | ||||
<list style="symbols"> | ||||
<t><spanx style="verb">display</spanx>: The alert should be displa | ||||
yed as appropriate for the current device and user context.</t> | ||||
<t><spanx style="verb">email</spanx>: The alert should trigger an | ||||
email sent out to the user, notifying about the alert. This action is typically | ||||
only appropriate for server implementations.</t> | ||||
</list></t> | ||||
</list></t> | ||||
</section> | </section> | |||
</section> | <section anchor="prop-alerts" numbered="true" toc="default"> | |||
<name>alerts</name> | ||||
<section anchor="localized-props" title="Multilingual Properties"> | <t>Type: <tt>Id[Alert]</tt> (optional)</t> | |||
<section anchor="prop-localizations" title="localizations"> | <t>This is a map of alert ids to Alert objects, representing alerts/re | |||
<t>Type: <spanx style="verb">String[PatchObject]</spanx> (optional).</ | minders to display or send to the user for this calendar object.</t> | |||
t> | <t>An Alert object has the following properties:</t> | |||
<dl newline="true"> | ||||
<t>A map of language tags <xref target="RFC5646" /> to patch objects, | <dt>@type: <tt>String</tt> (mandatory)</dt> | |||
which localize the calendar object into the locale of the respective language ta | <dd>This specifies the type of this object. This <bcp14>MUST</bcp1 | |||
g.</t> | 4> be <tt>Alert</tt>.</dd> | |||
<dt>trigger: <tt>OffsetTrigger|AbsoluteTrigger|UnknownTrigger</tt> | ||||
<t>See the description of <xref target="type-PatchObject">PatchObject< | (mandatory)</dt> | |||
/xref> for the structure of the PatchObject. The patches are applied to the top- | <dd><t>This defines when to trigger the alert. New types may be de | |||
level calendar object. In addition, the <spanx style="verb">locale</spanx> prope | fined in future documents.</t> | |||
rty of the patched object is set to the language tag. All pointers for patches M | <t>An <tt>OffsetTrigger</tt> object has the following properties:< | |||
UST end with one of the following suffixes; any patch that does not follow this | /t> | |||
MUST be ignored unless otherwise specified in a future RFC: | <dl newline="true"> | |||
<dt>@type: <tt>String</tt> (mandatory)</dt> | ||||
<list style="symbols"> | <dd>This specifies the type of this object. This <bcp14>MUST</ | |||
<t>title</t> | bcp14> be | |||
<t>description</t> | <tt>OffsetTrigger</tt>.</dd> | |||
<t>name</t> | <dt>offset: <tt>SignedDuration</tt> (mandatory)</dt> | |||
</list> | <dd>This defines the offset at which to trigger the alert rela | |||
tive to the time property | ||||
A patch MUST NOT have the prefix <spanx style="verb">recurrenceOverrid | defined in the <tt>relativeTo</tt> property of the alert. Neg | |||
es</spanx>; any localization of the override MUST be a patch to the localization | ative durations signify alerts | |||
s property inside the override instead. | before the time property; positive durations signify alerts | |||
after the time property.</dd> | ||||
For example, a patch to <spanx style="verb">locations/abcd1234/title</ | <dt>relativeTo: <tt>String</tt> (optional, default: <tt>start< | |||
spanx> is permissible, but a patch to <spanx style="verb">uid</spanx> or <spanx | /tt>)</dt> | |||
style="verb">recurrenceOverrides/2020-01-05T14:00:00/title</spanx> is not.</t> | <dd><t>This specifies the time property that the alert offset | |||
is relative to. The value | ||||
<bcp14>MUST</bcp14> be one of the following:</t> | ||||
<dl newline="false"> | ||||
<dt><tt>start</tt>:</dt> | ||||
<dd> triggers the alert relative to the start of the cale | ||||
ndar object</dd> | ||||
<dt><tt>end</tt>:</dt> | ||||
<dd> triggers the alert relative to the end/due time of t | ||||
he calendar object</dd> | ||||
</dl></dd></dl> | ||||
<t>An <tt>AbsoluteTrigger</tt> object has the following properties | ||||
:</t> | ||||
<dl newline="true"> | ||||
<dt>@type: <tt>String</tt> (mandatory)</dt> | ||||
<dd>This specifies the type of this object. This <bcp14>MUST</ | ||||
bcp14> be | ||||
<tt>AbsoluteTrigger</tt>.</dd> | ||||
<dt>when: <tt>UTCDateTime</tt> (mandatory)</dt> | ||||
<dd>This defines a specific UTC date-time when the alert is tr | ||||
iggered.</dd> | ||||
</dl> | ||||
<t>An <tt>UnknownTrigger</tt> object is an object that contains an | ||||
<tt>@type</tt> property whose | ||||
value is not recognized (i.e., not <tt>OffsetTrigger</tt> or | ||||
<tt>AbsoluteTrigger</tt>) plus zero | ||||
or more other properties. This is for compatibility wit | ||||
h client extensions and future | ||||
specifications. Implementations <bcp14>SHOULD NOT | ||||
</bcp14> trigger for trigger types they do not | ||||
understand but <bcp14>MUST</bcp14> preserve | ||||
them.</t> | ||||
</dd> | ||||
<dt>acknowledged: <tt>UTCDateTime</tt> (optional)</dt> | ||||
<dd><t>This records when an alert was last acknowledged. This is s | ||||
et when the user has dismissed | ||||
the alert; other clients that sync this property <bcp14>SHOUL | ||||
D</bcp14> automatically dismiss or | ||||
suppress duplicate alerts (alerts with the same alert i | ||||
d that triggered on or before this | ||||
date-time).</t> | ||||
<t>For a recurring calendar object, setting the <tt>acknowledged</ | ||||
tt> property <bcp14>MUST | ||||
NOT</bcp14> add a new override to the <tt>recurrenceOverrides | ||||
</tt> property. If the alert is not | ||||
already overridden, the <tt>acknowledged</tt> property | ||||
<bcp14>MUST</bcp14> be set on the alert in the | ||||
base event/task.</t> | ||||
<t>Certain kinds of alert action may not provide feedback as to wh | ||||
en the user sees them, for | ||||
example, email-based alerts. For those kinds of alerts, this | ||||
property <bcp14>MUST</bcp14> be set | ||||
immediately when the alert is triggered and the action | ||||
is successfully carried out.</t> | ||||
</dd> | ||||
<dt>relatedTo: <tt>String[Relation]</tt> (optional)</dt> | ||||
<dd>This relates this alert to other alerts in the same JSCal | ||||
endar object. If the user wishes to | ||||
snooze an alert, the application <bcp14>MUST</bcp14> cr | ||||
eate an alert to trigger after snoozing. | ||||
This new snooze alert <bcp14>MUST</bcp14> set a p | ||||
arent relation to the identifier of the original | ||||
alert.</dd> | ||||
<dt>action: <tt>String</tt> (optional, default: <tt>display</tt>)< | ||||
/dt> | ||||
<dd><t>This describes how to alert the user.</t> | ||||
<t>The value <bcp14>MUST</bcp14> be at most one of the following v | ||||
alues, a value registered in | ||||
the IANA "JSCalendar Enum Values" registry, or a ve | ||||
ndor-specific value (see <xref | ||||
target="custom-properties" format="default"/>):</t> | ||||
<dl spacing="normal"> | ||||
<dt><tt>display</tt>:</dt> | ||||
<dd>The alert should be displayed as appropriate for the current | ||||
device and user context.</dd> | ||||
<dt><tt>email</tt>:</dt> | ||||
<dd>The alert should trigger an email sent out to the user, notif | ||||
ying them of the alert. This | ||||
action is typically only appropriate for server implementations.< | ||||
/dd> | ||||
</dl></dd> | ||||
</dl> | ||||
</section> | ||||
</section> | ||||
<section anchor="localized-props" numbered="true" toc="default"> | ||||
<name>Multilingual Properties</name> | ||||
<section anchor="prop-localizations" numbered="true" toc="default"> | ||||
<name>localizations</name> | ||||
<t>Type: <tt>String[PatchObject]</tt> (optional)</t> | ||||
<t>A map where each key is a language tag <xref target="BCP47" format= | ||||
"default"/>, and the corresponding value is a set of patches to apply to the cal | ||||
endar object in order to localize it into that locale.</t> | ||||
<t>See the description of <xref target="type-PatchObject" format="defa | ||||
ult">PatchObject</xref> for the structure of the PatchObject. The patches are ap | ||||
plied to the top-level calendar object. In addition, the <tt>locale</tt> propert | ||||
y of the patched object is set to the language tag. All pointers for patches <bc | ||||
p14>MUST</bcp14> end with one of the following suffixes; any patch that does not | ||||
follow this <bcp14>MUST</bcp14> be ignored unless otherwise specified in a futu | ||||
re RFC: | ||||
<t>Note that this specification does not define how to maintain validi | </t> | |||
ty of localized content. For example, a client application changing a JSCalendar | <ul spacing="normal"> | |||
object's title property might also need to update any localizations of this pro | <li>title</li> | |||
perty. Client implementations SHOULD provide the means to manage localizations, | <li>description</li> | |||
but how to achieve this is specific to the application's workflow and requiremen | <li>name</li> | |||
ts.</t> | </ul> | |||
<t>A patch <bcp14>MUST NOT</bcp14> have the prefix <tt>recurrenceOverr | ||||
ides</tt>; any localization of | ||||
the override <bcp14>MUST</bcp14> be a patch to the <tt>localizations< | ||||
/tt> property inside the override | ||||
instead. For example, a patch to <tt>locations/abcd1234/title</tt> | ||||
is permissible, but a patch to | ||||
<tt>uid</tt> or <tt>recurrenceOverrides/2020-01-05T14:00:00/title | ||||
</tt> is not.</t> | ||||
<t>Note that this specification does not define how to maintain validi | ||||
ty of localized content. For example, a client application changing a JSCalendar | ||||
object's <tt>title</tt> property might also need to update any localizations of | ||||
this property. Client implementations <bcp14>SHOULD</bcp14> provide the means t | ||||
o manage localizations, but how to achieve this is specific to the application's | ||||
workflow and requirements.</t> | ||||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="timezone-props" numbered="true" toc="default"> | ||||
<section anchor="timezone-props" title="Time Zone Properties"> | <name>Time Zone Properties</name> | |||
<section anchor="prop-timeZone" title="timeZone"> | <section anchor="prop-timeZone" numbered="true" toc="default"> | |||
<t>Type: <spanx style="verb">TimeZoneId|null</spanx> (optional, defaul | <name>timeZone</name> | |||
t: null).</t> | <t>Type: <tt>TimeZoneId|null</tt> (optional, default: null)</t> | |||
<t>This identifies the time zone the object is scheduled in or is null | ||||
<t>Identifies the time zone the object is scheduled in, or null for fl | for floating time. This is | |||
oating time. This is either a name from the IANA Time Zone Database <xref target | either a name from the IANA Time Zone Database <xref target="TZDB" fo | |||
="TZDB" /> or the TimeZoneId of a custom time zone from the <spanx style="verb"> | rmat="default"/> or the | |||
timeZones</spanx> property (<xref target="prop-timeZones" />). If omitted, this | TimeZoneId of a custom time zone from the <tt>timeZones</tt> proper | |||
MUST be presumed to be null (i.e., floating time).</t> | ty (<xref target="prop-timeZones" | |||
format="default"/>). If omitted, this <bcp14>MUST</bcp14> be pres | ||||
umed to be null (i.e., floating | ||||
time).</t> | ||||
</section> | </section> | |||
<section anchor="prop-timeZones" numbered="true" toc="default"> | ||||
<name>timeZones</name> | ||||
<t>Type: <tt>TimeZoneId[TimeZone]</tt> (optional)</t> | ||||
<t>This maps identifiers of custom time zones to their time zone defin | ||||
itions. The following | ||||
restrictions apply for each key in the map:</t> | ||||
<ul spacing="normal"> | ||||
<li>To avoid conflict with names in the IANA Time Zone Database <xre | ||||
f target="TZDB" format="default"/>, it <bcp14>MUST</bcp14> start with the <tt>/< | ||||
/tt> character.</li> | ||||
<li>It <bcp14>MUST</bcp14> be a valid <tt>paramtext</tt> value, as s | ||||
pecified in <xref target="RFC5545" sectionFormat="of" section="3.1"/>.</li> | ||||
<li>At least one other property in the same JSCalendar object <bcp14 | ||||
>MUST</bcp14> reference a time zone using this identifier (i.e., orphaned time z | ||||
ones are not allowed).</li> | ||||
</ul> | ||||
<t>An identifier need only be unique to this JSCalendar object. It <bc | ||||
p14>MAY</bcp14> differ from the | ||||
<tt>tzId</tt> property value of the TimeZone object it maps to.</t> | ||||
<t>A JSCalendar object may be part of a hierarchy of other JSCalendar ob | ||||
jects (say, an Event is an entry in a Group). In this case, the set of time zone | ||||
s is the sum of the time zone definitions of this object and its parent objects. | ||||
If multiple time zones with the same identifier exist, then the definition clos | ||||
est to the calendar object in relation to its parents <bcp14>MUST</bcp14> be use | ||||
d. (In context of Event, a time zone definition in its <tt>timeZones</tt> proper | ||||
ty has precedence over a definition of the same id in the Group). Time zone defi | ||||
nitions in any children of the calendar object <bcp14>MUST</bcp14> be ignored.</ | ||||
t> | ||||
<t>A TimeZone object maps a VTIMEZONE component from iCalendar, and th | ||||
e semantics are as defined in | ||||
<xref target="RFC5545" format="default"/>. A valid time zone <bcp14> | ||||
MUST</bcp14> | ||||
define at least one transition rule in the <tt>standard</tt> or <t | ||||
t>daylight</tt> property. Its | ||||
properties are:</t> | ||||
<dl newline="true"> | ||||
<dt>@type: <tt>String</tt> (mandatory)</dt> | ||||
<dd>This specifies the type of this object. This <bcp14>MUST</bcp1 | ||||
4> be <tt>TimeZone</tt>.</dd> | ||||
<dt>tzId: <tt>String</tt> (mandatory)</dt> | ||||
<dd>This is the TZID property from iCalendar. Note that this impli | ||||
es that the value <bcp14>MUST</bcp14> be a valid <tt>paramtext</tt> value as spe | ||||
cified in Section 3.1. of <xref target="RFC5545" format="default"/>.</dd> | ||||
<dt>updated: <tt>UTCDateTime</tt> (optional)</dt> | ||||
<dd>This is the LAST-MODIFIED property from iCalendar.</dd> | ||||
<dt>url: <tt>String</tt> (optional)</dt> | ||||
<dd>This is the TZURL property from iCalendar.</dd> | ||||
<dt>validUntil: <tt>UTCDateTime</tt> (optional)</dt> | ||||
<dd>This is the TZUNTIL property from iCalendar, specified in <xre | ||||
f target="RFC7808" | ||||
format="default"/>.</dd> | ||||
<dt>aliases: <tt>String[Boolean]</tt> (optional)</dt> | ||||
<dd>This maps the TZID-ALIAS-OF properties from iCalendar, specifi | ||||
ed in <xref target="RFC7808" | ||||
format="default"/>, to a JSON set of aliases. The set is repr | ||||
esented as an object, with the keys | ||||
being the aliases. The value for each key in the map <bcp14>M | ||||
UST</bcp14> be true.</dd> | ||||
<dt>standard: <tt>TimeZoneRule[]</tt> (optional)</dt> | ||||
<dd>This the STANDARD sub-components from iCalendar. The order <bc | ||||
p14>MUST</bcp14> be preserved | ||||
during conversion.</dd> | ||||
<dt>daylight: <tt>TimeZoneRule[]</tt> (optional)</dt> | ||||
<dd>This the DAYLIGHT sub-components from iCalendar. The order <bc | ||||
p14>MUST</bcp14> be preserved | ||||
during conversion.</dd> | ||||
</dl> | ||||
<section anchor="prop-timeZones" title="timeZones"> | <t>A TimeZoneRule object maps a STANDARD or DAYLIGHT sub-component fro | |||
<t>Type: <spanx style="verb">TimeZoneId[TimeZone]</spanx> (optional).< | m iCalendar, with the | |||
/t> | restriction that, at most, one recurrence rule is allowed per rule. I | |||
t has the following | ||||
<t>Maps identifiers of custom time zones to their time zone definition | properties:</t> | |||
s. The following restrictions apply for each key in the map: | <dl newline="true"> | |||
<dt>@type: <tt>String</tt> (mandatory)</dt> | ||||
<list style="symbols"> | <dd>This specifies the type of this object. This <bcp14>MUST</bcp1 | |||
<t>To avoid conflict with names in the IANA Time Zone Database <xref | 4> be | |||
target="TZDB" />, it MUST start with the <spanx style="verb">/</spanx> characte | <tt>TimeZoneRule</tt>.</dd> | |||
r.</t> | <dt>start: <tt>LocalDateTime</tt> (mandatory)</dt> | |||
<dd>This is the DTSTART property from iCalendar.</dd> | ||||
<t>It MUST be a valid <spanx style="verb">paramtext</spanx> value as | <dt>offsetFrom: <tt>String</tt> (mandatory)</dt> | |||
specified in Section 3.1. of <xref target="RFC5545" />.</t> | <dd>This is the TZOFFSETFROM property from iCalendar.</dd> | |||
<dt>offsetTo: <tt>String</tt> (mandatory)</dt> | ||||
<t>At least one other property in the same JSCalendar object MUST re | <dd>This is the TZOFFSETTO property from iCalendar.</dd> | |||
ference a time zone using this identifier (i.e., orphaned time zones are not all | <dt>recurrenceRules: <tt>RecurrenceRule[]</tt> (optional)</dt> | |||
owed).</t> | <dd>This is the RRULE property mapped, as specified in <xref targe | |||
</list> | t="prop-recurrenceRules" | |||
format="default"/>. During recurrence rule evaluation, the <t | ||||
An identifier need only be unique to this JSCalendar object. A JSCalen | t>until</tt> property value | |||
dar object may be part in a hierarchy of other JSCalendar objects (say, a JSEven | <bcp14>MUST</bcp14> be interpreted as a local time in the UTC | |||
t is an entry in a JSGroup). In this case, the set of time zones is the sum of t | time zone.</dd> | |||
he time zone definitions of this object and its parent objects. If multiple time | <dt>recurrenceOverrides: <tt>LocalDateTime[PatchObject]</tt> (opti | |||
zones with the same identifier exist, then the definition closest to the calend | onal)</dt> | |||
ar object in relation to its parents MUST be used. (In context of JSEvent, a tim | <dd>This maps the RDATE properties from iCalendar. The set is repr | |||
e zone definition in its timeZones property has precedence over a definition of | esented as an object, with the | |||
the same id in the JSGroup). Time zone definitions in any children of the calend | keys being the recurrence dates. The patch object <bcp14>MUST | |||
ar object MUST be ignored. </t> | </bcp14> be the empty JSON object | |||
({}).</dd> | ||||
<t>A TimeZone object maps a VTIMEZONE component from iCalendar <xref t | <dt>names: <tt>String[Boolean]</tt> optional)</dt> | |||
arget="RFC5545" /> and the semantics are as defined there. A valid time zone MUS | <dd>This maps the TZNAME properties from iCalendar to a JSON set. | |||
T define at least one transition rule in the <spanx style="verb">standard</spanx | The set is represented as an | |||
> or <spanx style="verb">daylight</spanx> property. Its properties are: | object, with the keys being the names, excluding any <tt>tznp | |||
aram</tt> component from iCalendar. | ||||
<list style="symbols"> | The value for each key in the map <bcp14>MUST</bcp14> b | |||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | e true.</dd> | |||
<vspace blankLines="1" /> | <dt>comments: <tt>String[]</tt> (optional)</dt> | |||
Specifies the type of this object. This MUST be <spanx style="verb"> | <dd> This maps the COMMENT properties from iCalendar. The order < | |||
TimeZone</spanx>. | bcp14>MUST</bcp14> be preserved | |||
</t> | during conversion.</dd> | |||
<t>tzId: <spanx style="verb">String</spanx> (mandatory). | </dl> | |||
<vspace blankLines="1" /> | ||||
The TZID property from iCalendar.</t> | ||||
<t>updated: <spanx style="verb">UTCDateTime</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The LAST-MODIFIED property from iCalendar.</t> | ||||
<t>url: <spanx style="verb">String</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The TZURL property from iCalendar.</t> | ||||
<t>validUntil: <spanx style="verb">UTCDateTime</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The TZUNTIL property from iCalendar specified in <xref target="RFC78 | ||||
08" />.</t> | ||||
<t>aliases: <spanx style="verb">String[Boolean]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
Maps the TZID-ALIAS-OF properties from iCalendar specified in <xref | ||||
target="RFC7808" /> to a JSON set of aliases. The set is represented as an objec | ||||
t, with the keys being the aliases. The value for each key in the map MUST be tr | ||||
ue.</t> | ||||
<t>standard: <spanx style="verb">TimeZoneRule[]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
The STANDARD sub-components from iCalendar. The order MUST be preser | ||||
ved during conversion.</t> | ||||
<t>daylight: <spanx style="verb">TimeZoneRule[]</spanx> (optional). | ||||
<vspace blankLines="1" /> | ||||
The DAYLIGHT sub-components from iCalendar. The order MUST be preser | ||||
ved during conversion.</t> | ||||
</list></t> | ||||
<t>A TimeZoneRule object maps a STANDARD or DAYLIGHT sub-component fro | ||||
m iCalendar, with the restriction that at most one recurrence rule is allowed pe | ||||
r rule. It has the following properties: | ||||
<list style="symbols"> | ||||
<t>@type: <spanx style="verb">String</spanx> (mandatory) | ||||
<vspace blankLines="1" /> | ||||
Specifies the type of this object. This MUST be <spanx style="verb"> | ||||
TimeZoneRule</spanx>. | ||||
</t> | ||||
<t>start: <spanx style="verb">LocalDateTime</spanx> (mandatory) | ||||
<vspace blankLines="1" /> | ||||
The DTSTART property from iCalendar.</t> | ||||
<t>offsetFrom: <spanx style="verb">String</spanx> (mandatory) | ||||
<vspace blankLines="1" /> | ||||
The TZOFFSETFROM property from iCalendar.</t> | ||||
<t>offsetTo: <spanx style="verb">String</spanx> (mandatory) | ||||
<vspace blankLines="1" /> | ||||
The TZOFFSETTO property from iCalendar.</t> | ||||
<t>recurrenceRules: <spanx style="verb">RecurrenceRule[]</spanx> (op | ||||
tional) | ||||
<vspace blankLines="1" /> | ||||
The RRULE property mapped as specified in <xref target="prop-recurre | ||||
nceRules" />. During recurrence rule evaluation, the <spanx style="verb">until</ | ||||
spanx> property value MUST be interpreted as a local time in the UTC time zone.< | ||||
/t> | ||||
<t>recurrenceOverrides: <spanx style="verb">LocalDateTime[PatchObjec | ||||
t]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
Maps the RDATE properties from iCalendar. The set is represented as | ||||
an object, with the keys being the recurrence dates. The patch object MUST be th | ||||
e empty JSON object ({}).</t> | ||||
<t>names: <spanx style="verb">String[Boolean]</spanx> (optional) | ||||
<vspace blankLines="1" /> | ||||
Maps the TZNAME properties from iCalendar to a JSON set. The set is | ||||
represented as an object, with the keys being the names, excluding any <spanx st | ||||
yle="verb">tznparam</spanx> component from iCalendar. The value for each key in | ||||
the map MUST be true.</t> | ||||
<t>comments: <spanx style="verb">String[]</spanx> (optional). Maps t | ||||
he COMMENT properties from iCalendar. The order MUST be preserved during convers | ||||
ion.</t> | ||||
</list></t> | ||||
</section> | </section> | |||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="jscalendar-object-props" numbered="true" toc="default"> | ||||
<section anchor="jscalendar-object-props" title="Type-specific JSCalendar Pr | <name>Type-Specific JSCalendar Properties</name> | |||
operties"> | <section anchor="jsevent-props" numbered="true" toc="default"> | |||
<section anchor="jsevent-props" title="JSEvent Properties"> | <name>Event Properties</name> | |||
<t>In addition to the common JSCalendar object <xref target="jscalendar- | <t>In addition to the common JSCalendar object <xref target="jscalendar- | |||
props">properties</xref> a JSEvent has the following properties:</t> | props" format="default">properties</xref>, an Event has the following properties | |||
:</t> | ||||
<section anchor="prop-start-jsevent" title="start"> | <section anchor="prop-start-jsevent" numbered="true" toc="default"> | |||
<t>Type: <spanx style="verb">LocalDateTime</spanx> (mandatory).</t> | <name>start</name> | |||
<t>Type: <tt>LocalDateTime</tt> (mandatory)</t> | ||||
<t>The date/time the event starts in the event's time zone (as specifi | <t>This is the date/time the event starts in the event's time zone (as | |||
ed in the <spanx style="verb">timeZone</spanx> property, see <xref target="prop- | specified in the | |||
timeZone" />).</t> | <tt>timeZone</tt> | |||
property, see <xref target="prop-timeZone" format="default"/>).</t> | ||||
</section> | </section> | |||
<section anchor="prop-duration" numbered="true" toc="default"> | ||||
<section anchor="prop-duration" title="duration"> | <name>duration</name> | |||
<t>Type: <spanx style="verb">Duration</spanx> (optional, default: <spa | <t>Type: <tt>Duration</tt> (optional, default: <tt>PT0S</tt>)</t> | |||
nx style="verb">PT0S</spanx>).</t> | <t>This is the zero or positive duration of the event in the event's s | |||
tart time zone. The end time of an event can be found by adding the duration to | ||||
<t>The zero or positive duration of the event in the event's start tim | the event's start time.</t> | |||
e zone. The end time of an event can be found by adding the duration to the even | <t>An Event <bcp14>MAY</bcp14> involve start and end locations that ar | |||
t's start time.</t> | e in different time zones (e.g., a transcontinental flight). This can be express | |||
ed using the <tt>relativeTo</tt> and <tt>timeZone</tt> properties of the Event's | ||||
<t>A JSEvent MAY involve start and end locations that are in different | Location objects (see <xref target="prop-locations" format="default"/>).</t> | |||
time zones (e.g., a trans-continental flight). This can be expressed using the | ||||
<spanx style="verb">relativeTo</spanx> and <spanx style="verb">timeZone</spanx> | ||||
properties of the JSEvent's Location objects (see <xref target="prop-locations" | ||||
/>).</t> | ||||
</section> | </section> | |||
<section anchor="prop-status-jsevent" numbered="true" toc="default"> | ||||
<section anchor="prop-status-jsevent" title="status"> | <name>status</name> | |||
<t>Type: <spanx style="verb">String</spanx> (optional, default: <spanx | <t>Type: <tt>String</tt> (optional, default: <tt>confirmed</tt>)</t> | |||
style="verb">confirmed</spanx>).</t> | <t>This is the scheduling status (<xref target="sharing-scheduling-pro | |||
perties" format="default"/>) of an Event. If set, it <bcp14>MUST</bcp14> be one | ||||
<t>The scheduling status (<xref target="sharing-scheduling-properties" | of the following values, another value registered in the IANA "JSCalendar E | |||
/>) of a JSEvent. If set, it MUST be one of the following values, another value | num Values" registry, or a vendor-specific value (see <xref target="custom- | |||
registered in the IANA JSCalendar Enum Values registry, or a vendor-specific va | properties" format="default"/>):</t> | |||
lue (see <xref target="custom-properties" />): | <dl newline="false"> | |||
<dt><tt>confirmed</tt>:</dt><dd>indicates the event is definitely ha | ||||
<list style="symbols"> | ppening</dd> | |||
<t><spanx style="verb">confirmed</spanx>: Indicates the event is def | <dt><tt>cancelled</tt>:</dt><dd>indicates the event has been cancell | |||
initely happening.</t> | ed</dd> | |||
<t><spanx style="verb">cancelled</spanx>: Indicates the event has be | <dt><tt>tentative</tt>:</dt><dd>indicates the event may happen</dd> | |||
en cancelled.</t> | </dl> | |||
<t><spanx style="verb">tentative</spanx>: Indicates the event may ha | ||||
ppen.</t> | ||||
</list></t> | ||||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="jstask-props" numbered="true" toc="default"> | ||||
<section anchor="jstask-props" title="JSTask Properties"> | <name>Task Properties</name> | |||
<t>In addition to the common JSCalendar object <xref target="jscalendar- | <t>In addition to the common JSCalendar object <xref target="jscalendar- | |||
props">properties</xref> a JSTask has the following properties:</t> | props" format="default">properties</xref>, a Task has the following properties:< | |||
/t> | ||||
<section anchor="prop-due" title="due"> | <section anchor="prop-due" numbered="true" toc="default"> | |||
<t>Type: <spanx style="verb">LocalDateTime</spanx> (optional).</t> | <name>due</name> | |||
<t>Type: <tt>LocalDateTime</tt> (optional)</t> | ||||
<t>The date/time the task is due in the task's time zone.</t> | <t>This is the date/time the task is due in the task's time zone.</t> | |||
</section> | </section> | |||
<section anchor="prop-start-jstask" numbered="true" toc="default"> | ||||
<section anchor="prop-start-jstask" title="start"> | <name>start</name> | |||
<t>Type: <spanx style="verb">LocalDateTime</spanx> (optional).</t> | <t>Type: <tt>LocalDateTime</tt> (optional)</t> | |||
<t>This the date/time the task should start in the task's time zone.</ | ||||
<t>The date/time the task should start in the task's time zone.</t> | t> | |||
</section> | </section> | |||
<section anchor="prop-estimatedDuration" numbered="true" toc="default"> | ||||
<section anchor="prop-estimatedDuration" title="estimatedDuration"> | <name>estimatedDuration</name> | |||
<t>Type: <spanx style="verb">Duration</spanx> (optional).</t> | <t>Type: <tt>Duration</tt> (optional)</t> | |||
<t>This specifies the estimated positive duration of time the task tak | ||||
<t>Specifies the estimated positive duration of time the task takes to | es to complete.</t> | |||
complete.</t> | ||||
</section> | </section> | |||
<section anchor="prop-percentComplete" numbered="true" toc="default"> | ||||
<section anchor="prop-percentComplete" title="percentComplete"> | <name>percentComplete</name> | |||
<t>Type: <spanx style="verb">UnsignedInt</spanx> (optional).</t> | <t>Type: <tt>UnsignedInt</tt> (optional)</t> | |||
<t>This represents the percent completion of the task overall. The pro | ||||
<t>Represents the percent completion of the task overall. The property | perty value <bcp14>MUST</bcp14> | |||
value MUST be a positive integer between 0 and 100.</t> | be a positive integer between 0 and 100.</t> | |||
</section> | </section> | |||
<section anchor="prop-progress" numbered="true" toc="default"> | ||||
<name>progress</name> | ||||
<t>Type: <tt>String</tt> (optional)</t> | ||||
<t>This defines the progress of this task. If omitted, the default pro | ||||
gress (<xref | ||||
target="sharing-scheduling-properties" format="default"/>) of a Task | ||||
is defined as follows (in | ||||
order of evaluation):</t> | ||||
<dl newline="false"> | ||||
<dt><tt>completed</tt>:</dt> | ||||
<dd>if the <tt>progress</tt> property value of all participants i | ||||
s <tt>completed</tt></dd> | ||||
<dt><tt>failed</tt>:</dt> | ||||
<dd> if at least one <tt>progress</tt> property value of a partic | ||||
ipant is <tt>failed</tt></dd> | ||||
<dt><tt>in-process</tt>:</dt> | ||||
<dd> if at least one <tt>progress</tt> property value of a partic | ||||
ipant is <tt>in-process</tt></dd> | ||||
<dt><tt>needs-action</tt>:</dt> | ||||
<dd>if none of the other criteria match</dd> | ||||
</dl> | ||||
<t>If set, it <bcp14>MUST</bcp14> be one of the following values, anot | ||||
her value registered in the IANA "JSCalendar Enum Values" registry, or | ||||
a vendor-specific value (see <xref target="custom-properties" format="default"/ | ||||
>): | ||||
<section anchor="prop-progress" title="progress"> | </t> | |||
<t>Type: <spanx style="verb">String</spanx> (optional).</t> | <dl newline="false"> | |||
<dt><tt>needs-action</tt>:</dt><dd>indicates the task needs action</ | ||||
<t>Defines the progress of this task. If omitted, the default progress | dd> | |||
(<xref target="sharing-scheduling-properties" />) of a JSTask is defined as fol | <dt><tt>in-process</tt>:</dt><dd>indicates the task is in process</d | |||
lows (in order of evaluation): | d> | |||
<dt><tt>completed</tt>:</dt><dd>indicates the task is completed</dd> | ||||
<list style="symbols"> | <dt><tt>failed</tt>:</dt><dd>indicates the task failed</dd> | |||
<t><spanx style="verb">completed</spanx>: if the <spanx style="verb" | <dt><tt>cancelled</tt>:</dt><dd>indicates the task was cancelled</dd | |||
>progress</spanx> property value of all participants is | > | |||
<spanx style="verb">completed</spanx>.</t> | </dl> | |||
<t><spanx style="verb">failed</spanx>: if at least one <spanx style= | ||||
"verb">progress</spanx> property value of a participant is <spanx style="verb">f | ||||
ailed</spanx>.</t> | ||||
<t><spanx style="verb">in-process</spanx>: if at least one <spanx st | ||||
yle="verb">progress</spanx> property value of a participant is <spanx style="ver | ||||
b">in-process</spanx>.</t> | ||||
<t><spanx style="verb">needs-action</spanx>: If none of the other cr | ||||
iteria match.</t> | ||||
</list></t> | ||||
<t>If set, it MUST be one of the following values, another value regis | ||||
tered in the IANA JSCalendar Enum Values registry, or a vendor-specific value (s | ||||
ee <xref target="custom-properties" />): | ||||
<list style="symbols"> | ||||
<t><spanx style="verb">needs-action</spanx>: Indicates the task need | ||||
s action.</t> | ||||
<t><spanx style="verb">in-process</spanx>: Indicates the task is in | ||||
process.</t> | ||||
<t><spanx style="verb">completed</spanx>: Indicates the task is comp | ||||
leted.</t> | ||||
<t><spanx style="verb">failed</spanx>: Indicates the task failed.</t | ||||
> | ||||
<t><spanx style="verb">cancelled</spanx>: Indicates the task was can | ||||
celled.</t> | ||||
</list></t> | ||||
</section> | </section> | |||
<section anchor="prop-progressUpdated" numbered="true" toc="default"> | ||||
<section anchor="prop-progressUpdated" title="progressUpdated"> | <name>progressUpdated</name> | |||
<t>Type: <spanx style="verb">UTCDateTime</spanx> (optional).</t> | <t>Type: <tt>UTCDateTime</tt> (optional)</t> | |||
<t>This specifies the date/time the <tt>progress</tt> property of eith | ||||
<t>Specifies the date/time the <spanx style="verb">progress</spanx> pr | er the task overall (<xref target="prop-progress" format="default"/>) or a speci | |||
operty of either the task overall (<xref target="prop-progress" />) or a specifi | fic participant (<xref target="prop-participants" format="default"/>) was last u | |||
c participant (<xref target="prop-participants" />) was last updated.</t> | pdated.</t> | |||
<t>If the task is recurring and has future instances, a client may wan | ||||
<t>If the task is recurring and has future instances, a client may wan | t to keep track of the last progress update timestamp of a specific task recurre | |||
t to keep track of the last progress update timestamp of a specific task recurre | nce but leave other instances unchanged. One way to achieve this is by overridin | |||
nce, but leave other instances unchanged. One way to achieve this is by overridi | g the <tt>progressUpdated</tt> property in the task <tt>recurrenceOverrides</tt> | |||
ng the progressUpdated property in the task <spanx style="verb">recurrenceOverri | property. However, this could produce a long list of timestamps for regularly r | |||
des</spanx> property. However, this could produce a long list of timestamps for | ecurring tasks. An alternative approach is to split the Task into a current, sin | |||
regularly recurring tasks. An alternative approach is to split the JSTask into a | gle instance of Task with this instance progress update time and a future recurr | |||
current, single instance of JSTask with this instance progress update time and | ing instance. See also <xref target="prop-relatedTo" format="default"/> on split | |||
a future recurring instance. See also <xref target="prop-relatedTo" /> on splitt | ting.</t> | |||
ing.</t> | ||||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="jsgroup-props" numbered="true" toc="default"> | ||||
<section anchor="jsgroup-props" title="JSGroup Properties"> | <name>Group Properties</name> | |||
<t>JSGroup supports the following common <xref target="jscalendar-props" | <t>Group supports the following common <xref target="jscalendar-props" f | |||
>JSCalendar properties</xref>: | ormat="default">JSCalendar properties</xref>:</t> | |||
<list style="symbols"> | <ul spacing="normal"> | |||
<t>@type</t> | <li>@type</li> | |||
<t>uid</t> | <li>uid</li> | |||
<t>prodId</t> | <li>prodId</li> | |||
<t>created</t> | <li>created</li> | |||
<t>updated</t> | <li>updated</li> | |||
<t>title</t> | <li>title</li> | |||
<t>description</t> | <li>description</li> | |||
<t>descriptionContentType</t> | <li>descriptionContentType</li> | |||
<t>links</t> | <li>links</li> | |||
<t>locale</t> | <li>locale</li> | |||
<t>keywords</t> | <li>keywords</li> | |||
<t>categories</t> | <li>categories</li> | |||
<t>color</t> | <li>color</li> | |||
<t>timeZones</t> | <li>timeZones</li> | |||
</list> | </ul> | |||
<t>In addition, the following Group-specific properties are supported:</ | ||||
In addition, the following JSGroup-specific properties are supported:</t | t> | |||
> | <section anchor="prop-entries" numbered="true" toc="default"> | |||
<name>entries</name> | ||||
<section anchor="prop-entries" title="entries"> | <t>Type: <tt>(Task|Event)[]</tt> (mandatory)</t> | |||
<t>Type: <spanx style="verb">(JSTask|JSEvent)[]</spanx> (mandatory).</ | <t>This is a collection of group members. Implementations <bcp14>MUST< | |||
t> | /bcp14> ignore entries of | |||
unknown type.</t> | ||||
<t>A collection of group members. Implementations MUST ignore entries | ||||
of unknown type.</t> | ||||
</section> | </section> | |||
<section anchor="prop-source" numbered="true" toc="default"> | ||||
<section anchor="prop-source" title="source"> | <name>source</name> | |||
<t>Type: <spanx style="verb">String</spanx> (optional).</t> | <t>Type: <tt>String</tt> (optional)</t> | |||
<t>This is the source from which updated versions of this group may be | ||||
<t>The source from which updated versions of this group may be retriev | retrieved. The value | |||
ed from. The value MUST be a URI.</t> | <bcp14>MUST</bcp14> be a URI.</t> | |||
</section> | </section> | |||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="examples" numbered="true" toc="default"> | ||||
<section anchor="examples" title="Examples"> | <name>Examples</name> | |||
<t>The following examples illustrate several aspects of the JSCalendar dat | <t>The following examples illustrate several aspects of the JSCalendar dat | |||
a model and format. The examples may omit mandatory or additional properties, wh | a model and format. The examples may omit mandatory or additional properties, wh | |||
ich is indicated by a placeholder property with key <spanx style="verb">...</spa | ich is indicated by a placeholder property with key <tt>...</tt>. While most of | |||
nx>. While most of the examples use calendar event objects, they are also illust | the examples use calendar event objects, they are also illustrative for tasks.</ | |||
rative for tasks.</t> | t> | |||
<!-- EXAMPLES START --> | <!-- EXAMPLES START --> | |||
<section anchor="example-simple-event" title="Simple event"> | <section anchor="example-simple-event" numbered="true" toc="default"> | |||
<t> | <name>Simple Event</name> | |||
This example illustrates a simple one-time event. It specifies a one-time ev | <t>This example illustrates a simple one-time event. It specifies a one- | |||
ent that begins on January 15, 2020 at 1pm New York local time and ends after 1 | time event that begins on | |||
hour. | January 15, 2020 at 1 pm New York local time and ends after 1 hour.</t> | |||
</t> | <sourcecode name="" type="json"><![CDATA[ | |||
<figure> | ||||
<artwork><![CDATA[ | ||||
{ | { | |||
"@type": "jsevent", | "@type": "Event", | |||
"uid": "a8df6573-0474-496d-8496-033ad45d7fea", | "uid": "a8df6573-0474-496d-8496-033ad45d7fea", | |||
"updated": "2020-01-02T18:23:04Z", | "updated": "2020-01-02T18:23:04Z", | |||
"title": "Some event", | "title": "Some event", | |||
"start": "2020-01-15T13:00:00", | "start": "2020-01-15T13:00:00", | |||
"timeZone": "America/New_York", | "timeZone": "America/New_York", | |||
"duration": "PT1H" | "duration": "PT1H" | |||
} | } | |||
]]></artwork> | ]]></sourcecode> | |||
</figure> | ||||
</section> | </section> | |||
<section anchor="example-simple-task" title="Simple task"> | <section anchor="example-simple-task" numbered="true" toc="default"> | |||
<t> | <name>Simple Task</name> | |||
This example illustrates a simple task for a plain to-do item. | <t>This example illustrates a simple task for a plain to-do item.</t> | |||
</t> | <sourcecode name="" type="json"><![CDATA[ | |||
<figure> | ||||
<artwork><![CDATA[ | ||||
{ | { | |||
"@type": "jstask", | "@type": "Task", | |||
"uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", | "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", | |||
"updated": "2020-01-09T14:32:01Z", | "updated": "2020-01-09T14:32:01Z", | |||
"title": "Do something" | "title": "Do something" | |||
} | } | |||
]]></artwork> | ]]></sourcecode> | |||
</figure> | </section> | |||
</section> | <section anchor="example-simple-group" numbered="true" toc="default"> | |||
<section anchor="example-simple-group" title="Simple group"> | <name>Simple Group</name> | |||
<t> | <t>This example illustrates a simple calendar object group that contains | |||
This example illustrates a simple calendar object group that contains an eve | an event and a task.</t> | |||
nt and a task. | <sourcecode name="" type="json"><![CDATA[ | |||
</t> | ||||
<figure> | ||||
<artwork><![CDATA[ | ||||
{ | { | |||
"@type": "jsgroup", | "@type": "Group", | |||
"uid": "bf0ac22b-4989-4caf-9ebd-54301b4ee51a", | "uid": "bf0ac22b-4989-4caf-9ebd-54301b4ee51a", | |||
"updated": "2020-01-15T18:00:00Z", | "updated": "2020-01-15T18:00:00Z", | |||
"name": "A simple group", | "name": "A simple group", | |||
"entries": [{ | "entries": [{ | |||
"@type": "jsevent", | "@type": "Event", | |||
"uid": "a8df6573-0474-496d-8496-033ad45d7fea", | "uid": "a8df6573-0474-496d-8496-033ad45d7fea", | |||
"updated": "2020-01-02T18:23:04Z", | "updated": "2020-01-02T18:23:04Z", | |||
"title": "Some event", | "title": "Some event", | |||
"start": "2020-01-15T13:00:00", | "start": "2020-01-15T13:00:00", | |||
"timeZone": "America/New_York", | "timeZone": "America/New_York", | |||
"duration": "PT1H" | "duration": "PT1H" | |||
}, | }, | |||
{ | { | |||
"@type": "jstask", | "@type": "Task", | |||
"uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", | "uid": "2a358cee-6489-4f14-a57f-c104db4dc2f2", | |||
"updated": "2020-01-09T14:32:01Z", | "updated": "2020-01-09T14:32:01Z", | |||
"title": "Do something" | "title": "Do something" | |||
}] | }] | |||
} | } | |||
]]></artwork> | ]]></sourcecode> | |||
</figure> | </section> | |||
</section> | <section anchor="example-all-day-event" numbered="true" toc="default"> | |||
<section anchor="example-all-day-event" title="All-day event"> | <name>All-Day Event</name> | |||
<t> | <t> | |||
This example illustrates an event for an international holiday. It specifies an all-day event on April 1 that occurs every year since the year 1900. | This example illustrates an event for an international holiday. It specifies an all-day event on April 1 that occurs every year since the year 1900. | |||
</t> | </t> | |||
<figure> | <sourcecode name="" type="json"><![CDATA[ | |||
<artwork><![CDATA[ | ||||
{ | { | |||
"...": "", | "...": "", | |||
"title": "April Fool's Day", | "title": "April Fool's Day", | |||
"showWithoutTime": true, | "showWithoutTime": true, | |||
"start": "1900-04-01T00:00:00", | "start": "1900-04-01T00:00:00", | |||
"duration": "P1D", | "duration": "P1D", | |||
"recurrenceRules": [{ | "recurrenceRules": [{ | |||
"@type": "RecurrenceRule", | "@type": "RecurrenceRule", | |||
"frequency": "yearly" | "frequency": "yearly" | |||
}] | }] | |||
} | } | |||
]]></artwork> | ]]></sourcecode> | |||
</figure> | </section> | |||
</section> | <section anchor="example-due-task" numbered="true" toc="default"> | |||
<section anchor="example-due-task" title="Task with a due date"> | <name>Task with a Due Date</name> | |||
<t> | <t> | |||
This example illustrates a task with a due date. It is a reminder to buy gro | This example illustrates a task with a due date. It is a reminder to buy gro | |||
ceries before 6pm Vienna local time on January 19, 2020. The calendar user expec | ceries before 6 pm Vienna local time on January 19, 2020. The calendar user expe | |||
ts to need 1 hour for shopping. | cts to need 1 hour for shopping. | |||
</t> | </t> | |||
<figure> | <sourcecode name="" type="json"><![CDATA[ | |||
<artwork><![CDATA[ | ||||
{ | { | |||
"...": "", | "...": "", | |||
"title": "Buy groceries", | "title": "Buy groceries", | |||
"due": "2020-01-19T18:00:00", | "due": "2020-01-19T18:00:00", | |||
"timeZone": "Europe/Vienna", | "timeZone": "Europe/Vienna", | |||
"estimatedDuration": "PT1H" | "estimatedDuration": "PT1H" | |||
} | } | |||
]]></artwork> | ]]></sourcecode> | |||
</figure> | </section> | |||
</section> | <section anchor="example-zoned-event-endtz" numbered="true" toc="default"> | |||
<section anchor="example-zoned-event-endtz" title="Event with end time zone"> | <name>Event with End Time Zone</name> | |||
<t> | <t> | |||
This example illustrates the use of end time zones by use of an internationa | This example illustrates the use of end time zones by use of an internationa | |||
l flight. The flight starts on April 1, 2020 at 9am in Berlin local time. The du | l flight. The flight starts on April 1, 2020 at 9 am in Berlin local time. The d | |||
ration of the flight is scheduled at 10 hours 30 minutes. The time at the flight | uration of the flight is scheduled at 10 hours 30 minutes. The time at the fligh | |||
's destination is in the same time zone as Tokyo. Calendar clients could use the | t's destination is in the same time zone as Tokyo. Calendar clients could use th | |||
end time zone to display the arrival time in Tokyo local time and highlight the | e end time zone to display the arrival time in Tokyo local time and highlight th | |||
time zone difference of the flight. The location names can serve as input for n | e time zone difference of the flight. The location names can serve as input for | |||
avigation systems. | navigation systems. | |||
</t> | </t> | |||
<figure> | <sourcecode name="" type="json"><![CDATA[ | |||
<artwork><![CDATA[ | ||||
{ | { | |||
"...": "", | "...": "", | |||
"title": "Flight XY51 to Tokyo", | "title": "Flight XY51 to Tokyo", | |||
"start": "2020-04-01T09:00:00", | "start": "2020-04-01T09:00:00", | |||
"timeZone": "Europe/Berlin", | "timeZone": "Europe/Berlin", | |||
"duration": "PT10H30M", | "duration": "PT10H30M", | |||
"locations": { | "locations": { | |||
"418d0b9b-b656-4b3c-909f-5b149ca779c9": { | "1": { | |||
"@type": "Location", | "@type": "Location", | |||
"rel": "start", | "rel": "start", | |||
"name": "Frankfurt Airport (FRA)" | "name": "Frankfurt Airport (FRA)" | |||
}, | }, | |||
"c2c7ac67-dc13-411e-a7d4-0780fb61fb08": { | "2": { | |||
"@type": "Location", | "@type": "Location", | |||
"rel": "end", | "rel": "end", | |||
"name": "Narita International Airport (NRT)", | "name": "Narita International Airport (NRT)", | |||
"timeZone": "Asia/Tokyo" | "timeZone": "Asia/Tokyo" | |||
} | } | |||
} | } | |||
} | } | |||
]]></artwork> | ]]></sourcecode> | |||
</figure> | </section> | |||
</section> | <section anchor="example-floating-event" numbered="true" toc="default"> | |||
<section anchor="example-floating-event" title="Floating-time event (with recurr | <name>Floating-Time Event (with Recurrence)</name> | |||
ence)"> | <t> | |||
<t> | This example illustrates the use of floating time. Since January 1, 2020, a | |||
This example illustrates the use of floating time. Since January 1, 2020, a | calendar user blocks 30 minutes every day to practice yoga at 7 am local time in | |||
calendar user blocks 30 minutes every day to practice Yoga at 7am local time, in | whatever time zone the user is located on that date. | |||
whatever time zone the user is located on that date. | </t> | |||
</t> | <sourcecode name="" type="json"><![CDATA[ | |||
<figure> | ||||
<artwork><![CDATA[ | ||||
{ | { | |||
"...": "", | "...": "", | |||
"title": "Yoga", | "title": "Yoga", | |||
"start": "2020-01-01T07:00:00", | "start": "2020-01-01T07:00:00", | |||
"duration": "PT30M", | "duration": "PT30M", | |||
"recurrenceRules": [{ | "recurrenceRules": [{ | |||
"@type": "RecurrenceRule", | "@type": "RecurrenceRule", | |||
"frequency": "daily" | "frequency": "daily" | |||
}] | }] | |||
} | } | |||
]]></artwork> | ]]></sourcecode> | |||
</figure> | </section> | |||
</section> | <section anchor="example-multi-location-event" numbered="true" toc="defaul | |||
<section anchor="example-multi-location-event" title="Event with multiple locati | t"> | |||
ons and localization"> | <name>Event with Multiple Locations and Localization</name> | |||
<t> | <t> | |||
This example illustrates an event that happens at both a physical and a virt ual location. Fans can see a live concert on premises or online. The event title and descriptions are localized. | This example illustrates an event that happens at both a physical and a virt ual location. Fans can see a live concert on premises or online. The event title and descriptions are localized. | |||
</t> | </t> | |||
<figure> | <sourcecode name="" type="json"><![CDATA[ | |||
<artwork><![CDATA[ | ||||
{ | { | |||
"...": "", | "...": "", | |||
"title": "Live from Music Bowl: The Band", | "title": "Live from Music Bowl: The Band", | |||
"description": "Go see the biggest music event ever!", | "description": "Go see the biggest music event ever!", | |||
"locale": "en", | "locale": "en", | |||
"start": "2020-07-04T17:00:00", | "start": "2020-07-04T17:00:00", | |||
"timeZone": "America/New_York", | "timeZone": "America/New_York", | |||
"duration": "PT3H", | "duration": "PT3H", | |||
"locations": { | "locations": { | |||
"c0503d30-8c50-4372-87b5-7657e8e0fedd": { | "c0503d30-8c50-4372-87b5-7657e8e0fedd": { | |||
"@type": "Location", | "@type": "Location", | |||
"name": "The Music Bowl", | "name": "The Music Bowl", | |||
"description": "Music Bowl, Central Park, New York", | "description": "Music Bowl, Central Park, New York", | |||
"coordinates": "geo:40.7829,-73.9654" | "coordinates": "geo:40.7829,-73.9654" | |||
} | } | |||
}, | }, | |||
"virtualLocations": { | "virtualLocations": { | |||
"1": { | "vloc1": { | |||
"@type": "VirtualLocation", | "@type": "VirtualLocation", | |||
"name": "Free live Stream from Music Bowl", | "name": "Free live Stream from Music Bowl", | |||
"uri": "https://stream.example.com/the_band_2020" | "uri": "https://stream.example.com/the_band_2020" | |||
} | } | |||
}, | }, | |||
"localizations": { | "localizations": { | |||
"de": { | "de": { | |||
"title": "Live von der Music Bowl: The Band!", | "title": "Live von der Music Bowl: The Band!", | |||
"description": "Schau dir das größte Musikereignis an!", | "description": "Schau dir das größte Musikereignis an!", | |||
"virtualLocations/1/name": "Gratis Live-Stream aus der Music Bowl" | "virtualLocations/vloc1/name": | |||
"Gratis Live-Stream aus der Music Bowl" | ||||
} | } | |||
} | } | |||
} | } | |||
]]></artwork> | ]]></sourcecode> | |||
</figure> | </section> | |||
</section> | <section anchor="example-recurring-overrides" numbered="true" toc="default | |||
<section anchor="example-recurring-overrides" title="Recurring event with overri | "> | |||
des"> | <name>Recurring Event with Overrides</name> | |||
<t> | <t> | |||
This example illustrates the use of recurrence overrides. A math course at a | This example illustrates the use of recurrence overrides. A math course at a | |||
University is held for the first time on January 8, 2020 at 9am London time and | university is held for the first time on January 8, 2020 at 9 am London time an | |||
occurs every week until June 24, 2020. Each lecture lasts for one hour and 30 m | d occurs every week until June 24, 2020. Each lecture lasts for one hour and 30 | |||
inutes and is located at the Mathematics department. This event has exceptional | minutes and is located at the Mathematics department. This event has exceptional | |||
occurrences: at the last occurrence of the course is an exam, which lasts for 2 | occurrences: at the last occurrence of the course is an exam, which lasts for 2 | |||
hours and starts at 10am. Also, the location of the exam differs from the usual | hours and starts at 10 am. Also, the location of the exam differs from the usua | |||
location. On April 1 no course is held. On January 7 at 2pm is an optional intro | l location. On April 1, no course is held. On January 7 at 2 pm, there is an opt | |||
duction course, that occurs before the first regular lecture. | ional introduction course, which occurs before the first regular lecture. | |||
</t> | </t> | |||
<figure> | <sourcecode name="" type="json"><![CDATA[ | |||
<artwork><![CDATA[ | ||||
{ | { | |||
"...": "", | "...": "", | |||
"title": "Calculus I", | "title": "Calculus I", | |||
"start": "2020-01-08T09:00:00", | "start": "2020-01-08T09:00:00", | |||
"timeZone": "Europe/London", | "timeZone": "Europe/London", | |||
"duration": "PT1H30M", | "duration": "PT1H30M", | |||
"locations": { | "locations": { | |||
"0dfb8ace-aad1-4734-b3b4-a2fe3d6ae1c5": { | "mlab": { | |||
"@type": "Location", | "@type": "Location", | |||
"title": "Math lab room 1", | "title": "Math lab room 1", | |||
"description": "Math Lab I, Department of Mathematics" | "description": "Math Lab I, Department of Mathematics" | |||
} | } | |||
}, | }, | |||
"recurrenceRules": [{ | "recurrenceRules": [{ | |||
"@type": "RecurrenceRule", | "@type": "RecurrenceRule", | |||
"frequency": "weekly", | "frequency": "weekly", | |||
"until": "2020-06-24T09:00:00" | "until": "2020-06-24T09:00:00" | |||
}], | }], | |||
skipping to change at line 1689 ¶ | skipping to change at line 1794 ¶ | |||
"title": "Introduction to Calculus I (optional)" | "title": "Introduction to Calculus I (optional)" | |||
}, | }, | |||
"2020-04-01T09:00:00": { | "2020-04-01T09:00:00": { | |||
"excluded": true | "excluded": true | |||
}, | }, | |||
"2020-06-25T09:00:00": { | "2020-06-25T09:00:00": { | |||
"title": "Calculus I Exam", | "title": "Calculus I Exam", | |||
"start": "2020-06-25T10:00:00", | "start": "2020-06-25T10:00:00", | |||
"duration": "PT2H", | "duration": "PT2H", | |||
"locations": { | "locations": { | |||
"84d639ca-37ac-4a86-81e5-9bbba8eb4053": { | "auditorium": { | |||
"@type": "Location", | "@type": "Location", | |||
"title": "Big Auditorium", | "title": "Big Auditorium", | |||
"description": "Big Auditorium, Other Road" | "description": "Big Auditorium, Other Road" | |||
} | } | |||
} | } | |||
} | } | |||
} | } | |||
} | } | |||
]]></artwork> | ]]></sourcecode> | |||
</figure> | </section> | |||
</section> | <section anchor="example-recurring-participants" numbered="true" toc="defa | |||
<section anchor="example-recurring-participants" title="Recurring event with par | ult"> | |||
ticipants"> | <name>Recurring Event with Participants</name> | |||
<t> | <t> | |||
This example illustrates scheduled events. A team meeting occurs every week | This example illustrates scheduled events. A team meeting occurs every week | |||
since January 8, 2020 at 9am Johannesburg time. The event owner also chairs the | since January 8, 2020 at 9 am Johannesburg time. The event owner also chairs the | |||
event. Participants meet in a virtual meeting room. An attendee has accepted the | event. Participants meet in a virtual meeting room. An attendee has accepted th | |||
invitation, but on March 4, 2020 he is unavailable and declined participation f | e invitation, but, on March 4, 2020, he is unavailable and declined participatio | |||
or this occurrence. | n for this occurrence. | |||
</t> | </t> | |||
<figure> | <sourcecode name="" type="json"><![CDATA[ | |||
<artwork><![CDATA[ | ||||
{ | { | |||
"...": "", | "...": "", | |||
"title": "FooBar team meeting", | "title": "FooBar team meeting", | |||
"start": "2020-01-08T09:00:00", | "start": "2020-01-08T09:00:00", | |||
"timeZone": "Africa/Johannesburg", | "timeZone": "Africa/Johannesburg", | |||
"duration": "PT1H", | "duration": "PT1H", | |||
"virtualLocations": { | "virtualLocations": { | |||
"3f41b47b-a5eb-494f-90eb-19d279486d84": { | "0": { | |||
"@type": "VirtualLocation", | "@type": "VirtualLocation", | |||
"name": "ChatMe meeting room", | "name": "ChatMe meeting room", | |||
"uri": "https://chatme.example.com?id=1234567&pw=a8a24627b63d396e" | "uri": "https://chatme.example.com?id=1234567&pw=a8a24627b63d" | |||
} | } | |||
}, | }, | |||
"recurrenceRules": [{ | "recurrenceRules": [{ | |||
"@type": "RecurrenceRule", | "@type": "RecurrenceRule", | |||
"frequency": "weekly" | "frequency": "weekly" | |||
}], | }], | |||
"replyTo": { | "replyTo": { | |||
"imip": "mailto:f245f875-7f63-4a5e-a2c8@schedule.example.com" | "imip": "mailto:f245f875-7f63-4a5e-a2c8@schedule.example.com" | |||
}, | }, | |||
"participants": { | "participants": { | |||
skipping to change at line 1762 ¶ | skipping to change at line 1866 ¶ | |||
} | } | |||
} | } | |||
}, | }, | |||
"recurrenceOverrides": { | "recurrenceOverrides": { | |||
"2020-03-04T09:00:00": { | "2020-03-04T09:00:00": { | |||
"participants/dG9tQGZvb2Jhci5xlLmNvbQ/participationStatus": | "participants/dG9tQGZvb2Jhci5xlLmNvbQ/participationStatus": | |||
"declined" | "declined" | |||
} | } | |||
} | } | |||
} | } | |||
]]></artwork> | ]]></sourcecode> | |||
</figure> | </section> | |||
</section> | ||||
<!-- EXAMPLES END --> | <!-- EXAMPLES END --> | |||
</section> | </section> | |||
<section anchor="security-considerations" numbered="true" toc="default"> | ||||
<section anchor="security-considerations" title="Security Considerations"> | <name>Security Considerations</name> | |||
<t>Calendaring and scheduling information is very privacy-sensitive. It c | <t>Calendaring and scheduling information is very privacy sensitive. It c | |||
an reveal the social network of a user; location information of this user and th | an reveal the social network of a user, location information of this user and th | |||
ose in their social network; identity and credentials information; and the patte | ose in their social network, identity and credentials information, and patterns | |||
rns of behavior of the user in both the physical and cyber realm. Additionally, | of behavior of the user in both the physical and cyber realm. Additionally, cale | |||
calendar events and tasks can could influence the physical location of a user or | ndar events and tasks can influence the physical location of a user or their cyb | |||
their cyber behavior within a known time window. Its transmission and storage | er behavior within a known time window. Its transmission and storage must be do | |||
must be done carefully to protect it from possible threats, such as eavesdroppin | ne carefully to protect it from possible threats, such as eavesdropping, replay, | |||
g, replay, message insertion, deletion, modification, and on-path attacks.</t> | message insertion, deletion, modification, and on-path attacks.</t> | |||
<t>The data being stored and transmitted may be used in systems with real- | ||||
<t>The data being stored and transmitted may be used in systems with real | world consequences. For example, a home automation system may turn an alarm on a | |||
world consequences. For example, a home automation system may turn an alarm on a | nd off or a coworking space may charge money to the organizer of an event that | |||
nd off. Or a coworking space may charge money to the organiser of an event that | books one of their meeting rooms. Such systems must be careful to authenticate a | |||
books one of their meeting rooms. Such systems must be careful to authenticate a | ll data they receive to prevent them from being subverted and ensure the change | |||
ll data they receive to prevent them from being subverted, and ensure the change | comes from an authorized entity.</t> | |||
comes from an authorized entity.</t> | <t>This document only defines the data format; such considerations are pri | |||
marily the concern of the API or method of storage and transmission of such file | ||||
<t>This document just defines the data format; such considerations are pri | s.</t> | |||
marily the concern of the API or method of storage and transmission of such file | <section anchor="sec-recurrences" numbered="true" toc="default"> | |||
s.</t> | <name>Expanding Recurrences</name> | |||
<t>A recurrence rule may produce infinite occurrences of an event. Imple | ||||
<section anchor="sec-recurrences" title="Expanding Recurrences"> | mentations <bcp14>MUST</bcp14> handle expansions carefully to prevent accidental | |||
<t>A recurrence rule may produce infinite occurrences of an event. Imple | or deliberate resource exhaustion.</t> | |||
mentations MUST handle expansions carefully to prevent accidental or deliberate | <t>Conversely, a recurrence rule may be specified that does not expand t | |||
resource exhaustion.</t> | o anything. It is not always possible to tell this through static analysis of th | |||
<t>Conversely, a recurrence rule may be specified that does not expand t | e rule, so implementations <bcp14>MUST</bcp14> be careful to avoid getting stuck | |||
o anything. It is not always possible to tell this through static analysis of th | in infinite loops or otherwise exhausting resources while searching for the nex | |||
e rule, so implementations MUST be careful to avoid getting stuck in infinite lo | t occurrence.</t> | |||
ops, or otherwise exhausting resources while searching for the next occurrence.< | <t>Events recur in the event's time zone. If the user is in a different | |||
/t> | time zone, daylight saving transitions may cause an event that normally occurs a | |||
<t>Events recur in the event's time zone. If the user is in a different | t, for example, 9 am to suddenly shift an hour earlier. This may be used in an a | |||
time zone, daylight saving transitions may cause an event that normally occurs a | ttempt to cause a participant to miss an important meeting. User agents must be | |||
t, for example, 9am to suddenly shift an hour earlier. This may be used in an at | careful to translate date-times correctly between time zones and may wish to cal | |||
tempt to cause a participant to miss an important meeting. User agents must be c | l out unexpected changes in the time of a recurring event.</t> | |||
areful to translate date-times correctly between time zones and may wish to call | ||||
out unexpected changes in the time of a recurring event.</t> | ||||
</section> | </section> | |||
<section anchor="json-parsing" numbered="true" toc="default"> | ||||
<section anchor="json-parsing" title="JSON Parsing"> | <name>JSON Parsing</name> | |||
<t>The Security Considerations of <xref target="RFC8259"/> apply to the | <t>The security considerations of <xref target="RFC8259" format="default | |||
use of JSON as the data interchange format. | "/> apply to the use of JSON as the data interchange format. | |||
</t> | </t> | |||
<t>As for any serialization format, parsers need to thoroughly check the syntax of the supplied data. JSON uses opening and closing tags for several typ es and structures, and it is possible that the end of the supplied data will be reached when scanning for a matching closing tag; this is an error condition, an d implementations need to stop scanning at the end of the supplied data.</t> | <t>As for any serialization format, parsers need to thoroughly check the syntax of the supplied data. JSON uses opening and closing tags for several typ es and structures, and it is possible that the end of the supplied data will be reached when scanning for a matching closing tag; this is an error condition, an d implementations need to stop scanning at the end of the supplied data.</t> | |||
<t>JSON also uses a string encoding with some escape sequences to encode special characters within a string. Care is needed when processing these escape sequences to ensure that they are fully formed before the special processing is triggered, with special care taken when the escape sequences appear adjacent to other (non-escaped) special characters or adjacent to the end of data (as in th e previous paragraph).</t> | <t>JSON also uses a string encoding with some escape sequences to encode special characters within a string. Care is needed when processing these escape sequences to ensure that they are fully formed before the special processing is triggered, with special care taken when the escape sequences appear adjacent to other (non-escaped) special characters or adjacent to the end of data (as in th e previous paragraph).</t> | |||
<t>If parsing JSON into a non-textual structured data format, implementa tions may need to allocate storage to hold JSON string elements. Since JSON doe s not use explicit string lengths, the risk of denial of service due to resource exhaustion is small, but implementations may still wish to place limits on the size of allocations they are willing to make in any given context, to avoid untr usted data causing excessive memory allocation.</t> | <t>If parsing JSON into a non-textual structured data format, implementa tions may need to allocate storage to hold JSON string elements. Since JSON doe s not use explicit string lengths, the risk of denial of service due to resource exhaustion is small, but implementations may still wish to place limits on the size of allocations they are willing to make in any given context, to avoid untr usted data causing excessive memory allocation.</t> | |||
</section> | </section> | |||
<section anchor="uri-values" numbered="true" toc="default"> | ||||
<section anchor="uri-values" title="URI Values"> | <name>URI Values</name> | |||
<t>Several JSCalendar properties contain URIs as values, and processing | <t>Several JSCalendar properties contain URIs as values, and processing | |||
these properties requires extra care. Section 7 of <xref target="RFC3986" /> dis | these properties requires extra care. <xref target="RFC3986" sectionFormat="of" | |||
cusses security risks related to URIs.</t> | section="7"/> discusses security risks related to URIs.</t> | |||
<t>Fetching remote resources carries inherent risks. Connections must on | <t>Fetching remote resources carries inherent risks. Connections must on | |||
ly be allowed on well known ports, using allowed protocols (generally just HTTP/ | ly be allowed on well-known ports, using allowed protocols (generally, just HTTP | |||
HTTPS on their default ports). The URL must be resolved externally and not allow | /HTTPS on their default ports). The URL must be resolved externally and not allo | |||
ed to access internal resources. Connecting to an external source reveals IP (an | wed to access internal resources. Connecting to an external source reveals IP (a | |||
d therefore generally location) information.</t> | nd therefore often location) information.</t> | |||
<t>A maliciously constructed JSCalendar object may contain a very large number of URIs. In the case of published calendars with a large number of subscr ibers, such objects could be widely distributed. Implementations should be caref ul to limit the automatic fetching of linked resources to reduce the risk of thi s being an amplification vector for a denial-of-service attack.</t> | <t>A maliciously constructed JSCalendar object may contain a very large number of URIs. In the case of published calendars with a large number of subscr ibers, such objects could be widely distributed. Implementations should be caref ul to limit the automatic fetching of linked resources to reduce the risk of thi s being an amplification vector for a denial-of-service attack.</t> | |||
</section> | </section> | |||
<section anchor="spam" numbered="true" toc="default"> | ||||
<section anchor="spam" title="Spam"> | <name>Spam</name> | |||
<t>Calendar systems may receive JSCalendar files from untrusted sources, | <t>Calendar systems may receive JSCalendar files from untrusted sources, | |||
in particular as attachments to emails. This can be a vector for an attacker to | in particular, as attachments to emails. This can be a vector for an attacker t | |||
inject spam into a user's calendar. This may confuse, annoy, and mislead users, | o inject spam into a user's calendar. This may confuse, annoy, and mislead users | |||
or overwhelm their calendar with bogus events, preventing them from seeing legi | or overwhelm their calendar with bogus events, preventing them from seeing legi | |||
timate ones.</t> | timate ones.</t> | |||
<t>Heuristic, statistical or machine-learning-based filters can be effec | <t>Heuristic, statistical, or machine-learning-based filters can be effe | |||
tive in filtering out spam. Authentication mechanisms such as DKIM <xref target= | ctive in filtering out spam. Authentication mechanisms, such as DomainKeys Ident | |||
"RFC6376" /> can help establish the source of messages and associate the data wi | ified Mail (DKIM) <xref target="RFC6376" format="default"/>, can help establish | |||
th existing relationships (such as an address book contact). Misclassifications | the source of messages and associate the data with existing relationships (such | |||
are always possible, however, and providing a mechanism for users to quickly cor | as an address book contact). However, misclassifications are always possible and | |||
rect this is advised.</t> | providing a mechanism for users to quickly correct this is advised.</t> | |||
<t>Confusable unicode characters may be used to trick a user into trusti ng a JSCalendar file that appears to come from a known contact but is actually f rom a similar-looking source controlled by an attacker.</t> | <t>Confusable unicode characters may be used to trick a user into trusti ng a JSCalendar file that appears to come from a known contact but is actually f rom a similar-looking source controlled by an attacker.</t> | |||
</section> | </section> | |||
<section anchor="duplication" numbered="true" toc="default"> | ||||
<section anchor="duplication" title="Duplication"> | <name>Duplication</name> | |||
<t>It is important for calendar systems to maintain the UID of an event | <t>It is important for calendar systems to maintain the UID of an event | |||
when updating it to avoid unexpected duplication of events. Consumers of the dat | when updating it to avoid an unexpected duplication of events. Consumers of the | |||
a may not remove the previous version of the event if it has a different UID. Th | data may not remove the previous version of the event if it has a different UID. | |||
is can lead to a confusing situation for the user, with many variations of the e | This can lead to a confusing situation for the user, with many variations of th | |||
vent and no indication of which one is correct. Care must be taken by consumers | e event and no indication of which one is correct. Care must be taken by consume | |||
of the data to remove old events where possible to avoid an accidental denial-of | rs of the data to remove old events where possible to avoid an accidental denial | |||
-service attack due to the volume of data.</t> | -of-service attack due to the volume of data.</t> | |||
</section> | </section> | |||
<section anchor="timezonesec" numbered="true" toc="default"> | ||||
<section anchor="timezonesec" title="Time Zones"> | <name>Time Zones</name> | |||
<t>Events recur in a particular time zone. When this differs from the us er's current time zone, it may unexpectedly cause an occurrence to shift in time for that user due to a daylight savings change in the event's time zone. A mali ciously crafted event could attempt to confuse users with such an event to ensur e a meeting is missed.</t> | <t>Events recur in a particular time zone. When this differs from the us er's current time zone, it may unexpectedly cause an occurrence to shift in time for that user due to a daylight savings change in the event's time zone. A mali ciously crafted event could attempt to confuse users with such an event to ensur e a meeting is missed.</t> | |||
</section> | </section> | |||
</section> | </section> | |||
<section anchor="iana-considerations" numbered="true" toc="default"> | ||||
<name>IANA Considerations</name> | ||||
<section anchor="iana-mime-type" numbered="true" toc="default"> | ||||
<name>Media Type Registration</name> | ||||
<t>This document defines a media type for use with JSCalendar data forma | ||||
tted in JSON.</t> | ||||
<dl newline="false" spacing="normal"> | ||||
<dt>Type name:</dt> | ||||
<dd>application</dd> | ||||
<dt>Subtype name:</dt> | ||||
<dd>jscalendar+json</dd> | ||||
<dt>Required parameters:</dt> | ||||
<dd><t>type</t> | ||||
<section anchor="iana-considerations" title="IANA Considerations"> | <t>The <tt>type</tt> parameter conveys the type of the JSCalendar da | |||
<section anchor="iana-mime-type" title="Media Type Registration"> | ta in the body part. The | |||
allowed parameter values correspond to the <tt>@type</tt> propert | ||||
y of the JSON-formatted | ||||
JSCalendar object in the body:</t> | ||||
<dl newline="false" spacing="normal"> | ||||
<dt><tt>event</tt>:</dt> | ||||
<dd>The <tt>@type</tt> property value <bcp14>MUST</bcp14> be | ||||
<tt>Event</tt>.</dd> | ||||
<dt><tt>task</tt>:</dt> | ||||
<dd>The <tt>@type</tt> property value <bcp14>MUST</bcp14> be | ||||
<tt>Task</tt>.</dd> | ||||
<dt><tt>group</tt>:</dt> | ||||
<dd>The <tt>@type</tt> property value <bcp14>MUST</bcp14> be | ||||
<tt>Group</tt>.</dd> | ||||
</dl> | ||||
<t>No other parameter values are allowed. The parameter <bcp14>MUST | ||||
NOT</bcp14> occur more than | ||||
once.</t> | ||||
</dd> | ||||
<dt>Optional parameters:</dt> | ||||
<dd>none</dd> | ||||
<dt>Encoding considerations:</dt> | ||||
<dd>This is the same as the encoding considerations of application/jso | ||||
n, as specified in <xref | ||||
target="RFC8259" sectionFormat="of" section="11"/>.</dd> | ||||
<dt>Security considerations:</dt> | ||||
<dd> See <xref target="security-considerations" format="default"/> of | ||||
this document.</dd> | ||||
<dt>Interoperability considerations:</dt> | ||||
<dd>While JSCalendar is designed to avoid ambiguities as much as possi | ||||
ble, when converting objects from other calendar formats to/from JSCalendar, it | ||||
is possible that differing representations for the same logical data or ambiguit | ||||
ies in interpretation might arise. The semantic equivalence of two JSCalendar ob | ||||
jects may be determined differently by different applications, for example, wher | ||||
e URL values differ in case between the two objects.</dd> | ||||
<dt>Published specification:</dt> | ||||
<dd>RFC 8984</dd> | ||||
<dt>Applications that use this media type:</dt> | ||||
<dd>Applications that currently make use of the text/calendar and appl | ||||
ication/calendar+json media types can use this as an alternative. Similarly, app | ||||
lications that use the application/json media type to transfer calendaring data | ||||
can use this to further specify the content.</dd> | ||||
<dt>Fragment identifier considerations:</dt> | ||||
<dd>A JSON Pointer fragment identifier may be used, as defined in <xre | ||||
f target="RFC6901" sectionFormat="comma" section="6"/>.</dd> | ||||
<dt>Additional information:</dt> | ||||
<dd> | ||||
<dl newline="false" spacing="normal"> | ||||
<dt>Magic number(s):</dt> | ||||
<dd>N/A</dd> | ||||
<dt>File extensions(s):</dt> | ||||
<dd>N/A</dd> | ||||
<dt>Macintosh file type code(s):</dt> | ||||
<dd>N/A</dd> | ||||
</dl> | ||||
</dd> | ||||
<dt>Person & email address to contact for further information:</dt | ||||
> | ||||
<dd>calsify@ietf.org</dd> | ||||
<dt>Intended usage:</dt> | ||||
<dd>COMMON</dd> | ||||
<dt>Restrictions on usage:</dt> | ||||
<dd>N/A</dd> | ||||
<dt>Author:</dt> | ||||
<dd>See the "Author's Address" section of this document.</dd> | ||||
<dt>Change controller:</dt> | ||||
<dd>IETF</dd> | ||||
</dl> | ||||
</section> | ||||
<section anchor="iana-property-registry" numbered="true" toc="default"> | ||||
<name>Creation of the "JSCalendar Properties" Registry</name> | ||||
<t>IANA has created the "JSCalendar Properties" registry to allow intero | ||||
perability of extensions to JSCalendar objects.</t> | ||||
<t>This registry follows the Expert Review process (<xref target="RFC812 | ||||
6" sectionFormat="comma" section="4.5"/>). If the "Intended Usage" field is <tt> | ||||
common</tt>, sufficient documentation is required to enable interoperability. Pr | ||||
eliminary community review for this registry is optional but strongly encouraged | ||||
.</t> | ||||
<t>A registration can have an intended usage of <tt>common</tt>, <tt>res | ||||
erved</tt>, or <tt>obsolete</tt>. IANA will list registrations with a common usa | ||||
ge designation prominently and separately from those with other intended usage v | ||||
alues.</t> | ||||
<t>A <tt>reserved</tt> registration reserves a property name without ass | ||||
igning semantics to avoid name collisions with future extensions or protocol use | ||||
.</t> | ||||
<t>An <tt>obsolete</tt> registration denotes a property that is no longe | ||||
r expected to be added by up-to-date systems. A new property has probably been d | ||||
efined covering the obsolete property's semantics.</t> | ||||
<t>The JSCalendar property registration procedure is not a formal standa | ||||
rds process but rather an administrative procedure intended to allow community c | ||||
omment and check it is coherent without excessive time delay. It is designed to | ||||
encourage vendors to document and register new properties they add for use cases | ||||
not covered by the original specification, leading to increased interoperabilit | ||||
y.</t> | ||||
<section anchor="iana-property-registry-preliminary-community-review" nu | ||||
mbered="true" toc="default"> | ||||
<name>Preliminary Community Review</name> | ||||
<t>Notice of a potential new registration <bcp14>SHOULD</bcp14> be sen | ||||
t to the Calext mailing list | ||||
<calsify@ietf.org> for review. This mailing list is appropriate | ||||
to solicit community feedback | ||||
on a proposed new property.</t> | ||||
<t>Property registrations must be marked with their intended use: "com | ||||
mon", "reserved", or | ||||
"obsolete".</t> | ||||
<t>The intent of the public posting to this list is to solicit comment | ||||
s and feedback on the choice of | ||||
the property name, the unambiguity of the specification document, and | ||||
a review of any | ||||
interoperability or security considerations. The submitter may subm | ||||
it a revised registration proposal | ||||
or abandon the registration completely at any time.</t> | ||||
</section> | ||||
<section anchor="iana-property-registry-submit-request-to-iana" numbered | ||||
="true" toc="default"> | ||||
<name>Submit Request to IANA</name> | ||||
<t>Registration requests can be sent to <iana@iana.org>.</t> | ||||
</section> | ||||
<section anchor="iana-property-registry-designated-expert-review" number | ||||
ed="true" toc="default"> | ||||
<name>Designated Expert Review</name> | ||||
<t>The primary concern of the designated expert (DE) is preventing nam | ||||
e collisions and encouraging | ||||
the submitter to document security and privacy considerations. For a | ||||
common-use registration, the DE | ||||
is expected to confirm that suitable documentation, as described in | ||||
<xref target="RFC8126" | ||||
sectionFormat="of" section="4.6"/>, is available to ensure intero | ||||
perability. That documentation will | ||||
usually be in an RFC, but simple definitions are likely to use a | ||||
web/wiki page, and if a sentence or | ||||
two is deemed sufficient, it could be described in the registry | ||||
itself. The DE should also verify that | ||||
the property name does not conflict with work that is active | ||||
or already published within the IETF. A | ||||
published specification is not required for reserved or obs | ||||
olete registrations.</t> | ||||
<t>The DE will either approve or deny the registration request and pub | ||||
lish a notice of the decision | ||||
to the Calext WG mailing list or its successor, as well as inform IAN | ||||
A. A denial notice must be | ||||
justified by an explanation, and, in the cases where it is possible | ||||
, concrete suggestions on how the | ||||
request can be modified so as to become acceptable should be prov | ||||
ided.</t> | ||||
</section> | ||||
<section anchor="iana-property-registry-change-procedures" numbered="tru | ||||
e" toc="default"> | ||||
<name>Change Procedures</name> | ||||
<t>Once a JSCalendar property has been published by IANA, the change c | ||||
ontroller may request a | ||||
change to its definition. The same procedure that would be appropriat | ||||
e for the original registration | ||||
request is used to process a change request.</t> | ||||
<t>JSCalendar property registrations may not be deleted; properties th | ||||
at are no longer believed appropriate for use can be declared obsolete by a chan | ||||
ge to their "intended usage" field; such properties will be clearly marked in th | ||||
e IANA registry.</t> | ||||
<t>Significant changes to a JSCalendar property's definition should be | ||||
requested only when there are | ||||
serious omissions or errors in the published specification, as such c | ||||
hanges may cause | ||||
interoperability issues. When review is required, a change request | ||||
may be denied if it renders | ||||
entities that were valid under the previous definition invalid un | ||||
der the new definition.</t> | ||||
<t>The owner of a JSCalendar property may pass responsibility to anoth | ||||
er person or agency by | ||||
informing IANA; this can be done without discussion or review.</t> | ||||
</section> | ||||
<section anchor="iana-property-registry-template" numbered="true" toc="d | ||||
efault"> | ||||
<name>"JSCalendar Properties" Registry Template</name> | ||||
<dl newline="false"> | ||||
<dt>Property Name:</dt> | ||||
<dd>This is the name of the property. The property name <bcp14>MU | ||||
ST NOT</bcp14> already be | ||||
registered for | ||||
any of the object types listed in the "Property Context" | ||||
field of this registration. Other object | ||||
types <bcp14>MAY</bcp14> already have registered a di | ||||
fferent property with the same name; however, | ||||
the same name <bcp14>SHOULD</bcp14> only be used | ||||
when the semantics are analogous.</dd> | ||||
<dt>Property Type:</dt> | ||||
<dd> This is the type of this property, using type signatures, as | ||||
specified in <xref target="type-signatures" format="default"/>. | ||||
The property type <bcp14>MUST</bcp14> be registered in the "J | ||||
SCalendar Types" registry.</dd> | ||||
<dt>Property Context:</dt> | ||||
<dd>This is a comma-separated list of JSCalendar object types thi | ||||
s property is allowed on.</dd> | ||||
<dt>Reference or Description:</dt> | ||||
<dd>This is a brief description or RFC number and section referen | ||||
ce where the property is specified (omitted for "reserved" property names).</dd> | ||||
<dt>Intended Usage:</dt> | ||||
<dd>This may be "common", "reserved", or "obsolete".</dd> | ||||
<dt>Change Controller:</dt> | ||||
<dd>This is who may request a change to this entry's definition ( | ||||
<tt>IETF</tt> for RFCs from the IETF stream).</dd> | ||||
</dl> | ||||
</section> | ||||
<section anchor="iana-property-registry-contents" numbered="true" toc="d | ||||
efault"> | ||||
<name>Initial Contents for the "JSCalendar Properties" Regis | ||||
try</name> | ||||
<t>The following table lists the initial entries of the "JSCalendar Pr | ||||
operties" registry. All properties are for common use. All RFC section reference | ||||
s are for this document. The change controller for all these properties is "IETF | ||||
".</t> | ||||
<t>This document defines a media type for use with JSCalendar data formatted i | <table anchor="tab-iana-property-registry" align="center"> | |||
n JSON.</t> | <name>Initial Contents of the "JSCalendar Properties" Registry</name | |||
> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Property Name</th> | ||||
<th align="left">Property Type</th> | ||||
<th align="left">Property Context</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">@type</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task, Group, AbsoluteTrigger, Alert, Lin | ||||
k, Location, NDay, OffsetTrigger, Participant, RecurrenceRule, Relation, TimeZon | ||||
e, TimeZoneRule, VirtualLocation</td> | ||||
<td align="left"> | ||||
<xref target="prop-type" format="default"/>, <xref target="pro | ||||
p-alerts" format="default"/>, <xref target="type-Link" format="default"/>, <xref | ||||
target="prop-locations" format="default"/>, <xref target="prop-participants" fo | ||||
rmat="default"/>, <xref target="prop-recurrenceRules" format="default"/>, <xref | ||||
target="type-Relation" format="default"/>, <xref target="prop-timeZones" format= | ||||
"default"/>, <xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">acknowledged</td> | ||||
<td align="left">UTCDateTime</td> | ||||
<td align="left">Alert</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">action</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Alert</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">alerts</td> | ||||
<td align="left">Id[Alert]</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">aliases</td> | ||||
<td align="left">String[Boolean]</td> | ||||
<td align="left">TimeZone</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">byDay</td> | ||||
<td align="left">NDay[]</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">byHour</td> | ||||
<td align="left">UnsignedInt[]</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">byMinute</td> | ||||
<td align="left">UnsignedInt[]</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">byMonth</td> | ||||
<td align="left">String[]</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">byMonthDay</td> | ||||
<td align="left">Int[]</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">bySecond</td> | ||||
<td align="left">UnsignedInt[]</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">bySetPosition</td> | ||||
<td align="left">Int[]</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">byWeekNo</td> | ||||
<td align="left">Int[]</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">byYearDay</td> | ||||
<td align="left">Int[]</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">categories</td> | ||||
<td align="left">String[Boolean]</td> | ||||
<td align="left">Event, Task, Group</td> | ||||
<td align="left"> | ||||
<xref target="prop-categories" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">cid</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Link</td> | ||||
<td align="left"> | ||||
<xref target="type-Link" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">color</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task, Group</td> | ||||
<td align="left"> | ||||
<xref target="prop-color" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">comments</td> | ||||
<td align="left">String[]</td> | ||||
<td align="left">TimeZoneRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">contentType</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Link</td> | ||||
<td align="left"> | ||||
<xref target="type-Link" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">coordinates</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Location</td> | ||||
<td align="left"> | ||||
<xref target="prop-locations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">count</td> | ||||
<td align="left">UnsignedInt</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">created</td> | ||||
<td align="left">UTCDateTime</td> | ||||
<td align="left">Event, Task, Group</td> | ||||
<td align="left"> | ||||
<xref target="prop-created" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">day</td> | ||||
<td align="left">String</td> | ||||
<td align="left">NDay</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">daylight</td> | ||||
<td align="left">TimeZoneRule[]</td> | ||||
<td align="left">TimeZone</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">delegatedFrom</td> | ||||
<td align="left">Id[Boolean]</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">delegatedTo</td> | ||||
<td align="left">Id[Boolean]</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">description</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task, Location, Participant, VirtualLoca | ||||
tion</td> | ||||
<td align="left"> | ||||
<xref target="prop-description" format="default"/>, <xref targ | ||||
et="prop-locations" format="default"/>, <xref target="prop-participants" format= | ||||
"default"/>, <xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">description&zwsp;ContentType</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-descriptionContentType" format="default"/>< | ||||
/td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">display</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Link</td> | ||||
<td align="left"> | ||||
<xref target="type-Link" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">due</td> | ||||
<td align="left">LocalDateTime</td> | ||||
<td align="left">Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-due" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">duration</td> | ||||
<td align="left">Duration</td> | ||||
<td align="left">Event</td> | ||||
<td align="left"> | ||||
<xref target="prop-duration" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">email</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">entries</td> | ||||
<td align="left">(Task|Event)[]</td> | ||||
<td align="left">Group</td> | ||||
<td align="left"> | ||||
<xref target="prop-entries" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">estimatedDuration</td> | ||||
<td align="left">Duration</td> | ||||
<td align="left">Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-estimatedDuration" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">excluded</td> | ||||
<td align="left">Boolean</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-excluded" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">excluded&zwsp;RecurrenceRules</td> | ||||
<td align="left">RecurrenceRule[]</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-excludedRecurrenceRules" format="default"/> | ||||
</td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">expectReply</td> | ||||
<td align="left">Boolean</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">features</td> | ||||
<td align="left">String[Boolean]</td> | ||||
<td align="left">VirtualLocation</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">firstDayOfWeek</td> | ||||
<td align="left">String</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">freeBusyStatus</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-freeBusyStatus" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">frequency</td> | ||||
<td align="left">String</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">href</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Link</td> | ||||
<td align="left"> | ||||
<xref target="type-Link" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">interval</td> | ||||
<td align="left">UnsignedInt</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">invitedBy</td> | ||||
<td align="left">Id</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">keywords</td> | ||||
<td align="left">String[Boolean]</td> | ||||
<td align="left">Event, Task, Group</td> | ||||
<td align="left"> | ||||
<xref target="prop-keywords" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">kind</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">language</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">links</td> | ||||
<td align="left">Id[Link]</td> | ||||
<td align="left">Group, Event, Task, Location, Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-links" format="default"/>, <xref target="pr | ||||
op-locations" format="default"/>, <xref target="prop-participants" format="defau | ||||
lt"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">locale</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Group, Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-locale" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">localizations</td> | ||||
<td align="left">String&zwsp;[PatchObject]</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-localizations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">locationId</td> | ||||
<td align="left">Id</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">locations</td> | ||||
<td align="left">Id[Location]</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-locations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">locationTypes</td> | ||||
<td align="left">String[Boolean]</td> | ||||
<td align="left">Location</td> | ||||
<td align="left"> | ||||
<xref target="prop-locations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">memberOf</td> | ||||
<td align="left">Id[Boolean]</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">method</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-method" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">name</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Location, VirtualLocation, Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-locations" format="default"/>, <xref target | ||||
="prop-virtualLocations" format="default"/>, <xref target="prop-participants" fo | ||||
rmat="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">names</td> | ||||
<td align="left">String[Boolean]</td> | ||||
<td align="left">TimeZoneRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">nthOfPeriod</td> | ||||
<td align="left">Int</td> | ||||
<td align="left">NDay</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">offset</td> | ||||
<td align="left">SignedDuration</td> | ||||
<td align="left">OffsetTrigger</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">offsetFrom</td> | ||||
<td align="left">UTCDateTime</td> | ||||
<td align="left">TimeZoneRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">offsetTo</td> | ||||
<td align="left">UTCDateTime</td> | ||||
<td align="left">TimeZoneRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">participants</td> | ||||
<td align="left">Id[Participant]</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">participation&zwsp;Comment</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">participationStatus</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">percentComplete</td> | ||||
<td align="left">UnsignedInt</td> | ||||
<td align="left">Task, Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-percentComplete" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">priority</td> | ||||
<td align="left">Int</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-priority" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">privacy</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-privacy" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">prodId</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task, Group</td> | ||||
<td align="left"> | ||||
<xref target="prop-prodId" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">progress</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Task, Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-progress" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">progressUpdated</td> | ||||
<td align="left">UTCDateTime</td> | ||||
<td align="left">Task, Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-progressUpdated" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">recurrenceId</td> | ||||
<td align="left">LocalDateTime</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceId" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">recurrenceIdTimeZone</td> | ||||
<td align="left">TimeZoneId|null</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceIdTimeZone" format="default"/></t | ||||
d> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">recurrenceOverrides</td> | ||||
<td align="left">LocalDateTime&zwsp;[PatchObject]</td> | ||||
<td align="left">Event, Task, TimeZoneRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceOverrides" format="default"/>, <x | ||||
ref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">recurrenceRules</td> | ||||
<td align="left">RecurrenceRule[]</td> | ||||
<td align="left">Event, Task, TimeZoneRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/>, <xref | ||||
target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">rel</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Link</td> | ||||
<td align="left"> | ||||
<xref target="type-Link" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">relatedTo</td> | ||||
<td align="left">String[Relation]</td> | ||||
<td align="left">Event, Task, Alert</td> | ||||
<td align="left"> | ||||
<xref target="prop-relatedTo" format="default"/>, <xref target | ||||
="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">relation</td> | ||||
<td align="left">String[Boolean]</td> | ||||
<td align="left">Relation</td> | ||||
<td align="left"> | ||||
<xref target="type-Relation" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">relativeTo</td> | ||||
<td align="left">String</td> | ||||
<td align="left">OffsetTrigger, Location</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/>, <xref target="p | ||||
rop-locations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">replyTo</td> | ||||
<td align="left">String[String]</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-replyTo" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">requestStatus</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-requestStatus" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">roles</td> | ||||
<td align="left">String[Boolean]</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">rscale</td> | ||||
<td align="left">String</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">sentBy</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task, Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-sentBy" format="default"/>, <xref target="p | ||||
rop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">standard</td> | ||||
<td align="left">TimeZoneRule[]</td> | ||||
<td align="left">TimeZone</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">start</td> | ||||
<td align="left">LocalDateTime</td> | ||||
<td align="left">TimeZoneRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">scheduleAgent</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">scheduleForceSend</td> | ||||
<td align="left">Boolean</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">scheduleSequence</td> | ||||
<td align="left">UnsignedInt</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">scheduleStatus</td> | ||||
<td align="left">String[]</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">scheduleUpdated</td> | ||||
<td align="left">UTCDateTime</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">sendTo</td> | ||||
<td align="left">String[String]</td> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">sequence</td> | ||||
<td align="left">UnsignedInt</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-sequence" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">showWithoutTime</td> | ||||
<td align="left">Boolean</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-showWithoutTime" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">size</td> | ||||
<td align="left">UnsignedInt</td> | ||||
<td align="left">Link</td> | ||||
<td align="left"> | ||||
<xref target="type-Link" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">skip</td> | ||||
<td align="left">String</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">source</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Group</td> | ||||
<td align="left"> | ||||
<xref target="prop-source" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">start</td> | ||||
<td align="left">LocalDateTime</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-start-jsevent" format="default"/>, <xref ta | ||||
rget="prop-start-jstask" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">status</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event</td> | ||||
<td align="left"> | ||||
<xref target="prop-status-jsevent" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">timeZone</td> | ||||
<td align="left">TimeZoneId|null</td> | ||||
<td align="left">Event, Task, Location</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZone" format="default"/>, <xref target= | ||||
"prop-locations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">timeZones</td> | ||||
<td align="left">TimeZoneId&zwsp;[TimeZone]</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">title</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task, Group, Link</td> | ||||
<td align="left"> | ||||
<xref target="prop-title" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">trigger</td> | ||||
<td align="left">OffsetTrigger|&zwsp;AbsoluteTrigger|&zwsp;Unkno | ||||
wnTrigger</td> | ||||
<td align="left">Alert</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">tzId</td> | ||||
<td align="left">String</td> | ||||
<td align="left">TimeZone</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">uid</td> | ||||
<td align="left">String</td> | ||||
<td align="left">Event, Task, Group</td> | ||||
<td align="left"> | ||||
<xref target="prop-uid" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">until</td> | ||||
<td align="left">LocalDateTime</td> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">updated</td> | ||||
<td align="left">UTCDateTime</td> | ||||
<td align="left">Event, Task, Group</td> | ||||
<td align="left"> | ||||
<xref target="prop-updated" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">uri</td> | ||||
<td align="left">String</td> | ||||
<td align="left">VirtualLocation</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">url</td> | ||||
<td align="left">String</td> | ||||
<td align="left">TimeZone</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">useDefaultAlerts</td> | ||||
<td align="left">Boolean</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="useDefaultAlerts" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">validUntil</td> | ||||
<td align="left">UTCDateTime</td> | ||||
<td align="left">TimeZone</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">virtualLocations</td> | ||||
<td align="left">Id&zwsp;[VirtualLocation]</td> | ||||
<td align="left">Event, Task</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">when</td> | ||||
<td align="left">UTCDateTime</td> | ||||
<td align="left">AbsoluteTrigger</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table> | ||||
</section> | ||||
</section> | ||||
<section anchor="iana-type-registry" numbered="true" toc="default"> | ||||
<name>Creation of the "JSCalendar Types" Registry</name> | ||||
<t>IANA has created the "JSCalendar Types" registry to avoid name collis | ||||
ions and provide a complete reference for all data types used for JSCalendar pro | ||||
perty values. The registration process is the same as for the "JSCalendar Proper | ||||
ties" registry, as defined in <xref target="iana-property-registry" format="defa | ||||
ult"/>.</t> | ||||
<section anchor="iana-type-registry-template" numbered="true" toc="defau | ||||
lt"> | ||||
<name>"JSCalendar Types" Registry Template</name> | ||||
<dl newline="false"> | ||||
<dt>Type Name:</dt> | ||||
<dd>the name of the type</dd> | ||||
<dt>Reference or Description:</dt> | ||||
<dd>a brief description or RFC number and section reference where | ||||
the Type is specified (may be omitted for "reserved" type names)</dd> | ||||
<dt>Intended Use:</dt> | ||||
<dd>common, reserved, or obsolete</dd> | ||||
<dt>Change Controller:</dt> | ||||
<dd>who may request a change to this entry's definition (<tt>IETF | ||||
</tt> for RFCs from the IETF stream)</dd> | ||||
</dl> | ||||
</section> | ||||
<section anchor="iana-type-registry-contents" numbered="true" toc="defau | ||||
lt"> | ||||
<name>Initial Contents for the "JSCalendar Types" Registry</ | ||||
name> | ||||
<t>The following table lists the initial entries of the JSCalendar Typ | ||||
es registry. All properties are for common use. All RFC section references are f | ||||
or this document. The change controller for all these properties is "IETF".</t> | ||||
<table anchor="tab-iana-type-registry" align="left"> | ||||
<name>Initial Contents of the "JSCalendar Types" Regist | ||||
ry</name> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Type Name</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">Alert</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">Boolean</td> | ||||
<td align="left"> | ||||
<xref target="type-signatures" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">Duration</td> | ||||
<td align="left"> | ||||
<xref target="type-Duration" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">Id</td> | ||||
<td align="left"> | ||||
<xref target="type-Id" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">Int</td> | ||||
<td align="left"> | ||||
<xref target="type-Int" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">LocalDateTime</td> | ||||
<td align="left"> | ||||
<xref target="type-LocalDateTime" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">Link</td> | ||||
<td align="left"> | ||||
<xref target="type-Link" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">Location</td> | ||||
<td align="left"> | ||||
<xref target="prop-locations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">NDay</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">Number</td> | ||||
<td align="left"> | ||||
<xref target="type-signatures" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">Participant</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">PatchObject</td> | ||||
<td align="left"> | ||||
<xref target="type-PatchObject" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">RecurrenceRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-recurrenceRules" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">Relation</td> | ||||
<td align="left"> | ||||
<xref target="type-Relation" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">SignedDuration</td> | ||||
<td align="left"> | ||||
<xref target="type-SignedDuration" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">String</td> | ||||
<td align="left"> | ||||
<xref target="type-signatures" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">TimeZone</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">TimeZoneId</td> | ||||
<td align="left"> | ||||
<xref target="type-timeZoneId" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">TimeZoneRule</td> | ||||
<td align="left"> | ||||
<xref target="prop-timeZones" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">UnsignedInt</td> | ||||
<td align="left"> | ||||
<xref target="type-UnsignedInt" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">UTCDateTime</td> | ||||
<td align="left"> | ||||
<xref target="type-UTCDateTime" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">VirtualLocation</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table> | ||||
</section> | ||||
</section> | ||||
<section anchor="iana-enum-registry" numbered="true" toc="default"> | ||||
<name>Creation of the "JSCalendar Enum Values" Registry</name> | ||||
<t>IANA has created the "JSCalendar Enum Values" registry to allow inter | ||||
operable extension of semantics for properties with enumerable values. Each such | ||||
property will have a subregistry of allowed values. The registration process fo | ||||
r a new enum value or adding a new enumerable property is the same as for the &q | ||||
uot;JSCalendar Properties" registry, as defined in <xref target="iana-prope | ||||
rty-registry" format="default"/>.</t> | ||||
<section anchor="iana-enum-registry-registry-template" numbered="true" t | ||||
oc="default"> | ||||
<name>"JSCalendar Enum Values" Registry Property Template</n | ||||
ame> | ||||
<t>This template is for adding a subregistry for a new enumerable prop | ||||
erty to the "JSCalendar Enum" registry.</t> | ||||
<dl newline="false"> | ||||
<dt>Property Name:</dt> | ||||
<dd>These are the name(s) of the property or properties where the | ||||
se values may be used. This <bcp14>MUST</bcp14> be registered in the "JSCal | ||||
endar Properties" registry.</dd> | ||||
<dt>Context:</dt> | ||||
<dd>This is the list of allowed object types where the property o | ||||
r properties may appear, as registered in the "JSCalendar Properties" | ||||
registry. This disambiguates where there may be two distinct properties with the | ||||
same name in different contexts.</dd> | ||||
<dt>Change Controller:</dt> | ||||
<dd> (<tt>IETF</tt> for properties defined in RFCs from the IETF | ||||
stream).</dd> | ||||
<dt>Initial Contents:</dt> | ||||
<dd>This is the initial list of defined values for this enum, usi | ||||
ng the template defined in <xref target="iana-enum-registry-value-template" form | ||||
at="default"/>. A subregistry will be created with these values for this propert | ||||
y name/context tuple.</dd> | ||||
</dl> | ||||
</section> | ||||
<section anchor="iana-enum-registry-value-template" numbered="true" toc= | ||||
"default"> | ||||
<name>"JSCalendar Enum Values" Registry Value Template</name | ||||
> | ||||
<t>This template is for adding a new enum value to a subregistry in th | ||||
e JSCalendar Enum registry.</t> | ||||
<dl newline="false"> | ||||
<dt>Enum Value:</dt> | ||||
<dd>the verbatim value of the enum</dd> | ||||
<dt>Reference or Description:</dt> | ||||
<dd>a brief description or RFC number and section reference for t | ||||
he semantics of this value</dd> | ||||
</dl> | ||||
</section> | ||||
<section anchor="iana-enum-registry-contents" numbered="true" toc="defau | ||||
lt"> | ||||
<name>Initial Contents for the "JSCalendar Enum Values" Regi | ||||
stry</name> | ||||
<t>For each subregistry created in this section, all RFC section refer | ||||
ences are for this document.</t> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>action</dd> | ||||
<dt>Context:</dt><dd>Alert</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-alert-action" align="left"> | ||||
<name>JSCalendar Enum Values for action (Context: Alert)</name> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">display</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">email</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<t><list style="hanging"> | <dl spacing="compact" newline="false" indent="20"> | |||
<t hangText="Type name:">application</t> | <dt>Property Name:</dt><dd>display</dd> | |||
<t hangText="Subtype name:">jscalendar+json</t> | <dt>Context:</dt><dd>Link</dd> | |||
<t hangText="Required parameters:">type | <dt>Change Controller:</dt><dd>IETF</dd> | |||
<vspace blankLines="1" /> | <dt>Initial Contents:</dt><dd> | |||
The <spanx style="verb">type</spanx> parameter conveys the type of the J | <table anchor="tab-iana-enum-link-display" align="left"> | |||
SCalendar data in the body part, with the value being one of <spanx style="verb" | <name>JSCalendar Enum Values for display (Context: Link)</name> | |||
>jsevent</spanx>, <spanx style="verb">jstask</spanx>, or <spanx style="verb">jsg | <thead> | |||
roup</spanx>. The parameter MUST NOT occur more than once. It MUST match the val | <tr> | |||
ue of the <spanx style="verb">@type</spanx> property of the JSON-formatted JSCal | <th align="left">Enum Value</th> | |||
endar object in the body.</t> | <th align="left">Reference or Description</th> | |||
<t hangText="Optional parameters:">none</t> | </tr> | |||
<t hangText="Encoding considerations:"> | </thead> | |||
Same as encoding considerations of application/json as specified in <xre | <tbody> | |||
f target="RFC8259">RFC8529, Section 11</xref>.</t> | <tr> | |||
<t hangText="Security considerations:"> See <xref target="security-considera | <td align="left">badge</td> | |||
tions" /> of this document.</t> | <td align="left"> | |||
<t hangText="Interoperability considerations:">While JSCalendar is designed | <xref target="type-Link" format="default"/></td> | |||
to avoid ambiguities as much as possible, when converting objects from other cal | </tr> | |||
endar formats to/from JSCalendar it is possible that differing representations f | <tr> | |||
or the same logical data might arise, or ambiguities in interpretation. The sema | <td align="left">graphic</td> | |||
ntic equivalence of two JSCalendar objects may be determined differently by diff | <td align="left"> | |||
erent applications, for example where URL values differ in case between the two | <xref target="type-Link" format="default"/></td> | |||
objects.</t> | </tr> | |||
<t hangText="Published specification:">This specification.</t> | <tr> | |||
<t hangText="Applications that use this media type:">Applications that curre | <td align="left">fullsize</td> | |||
ntly make use of the text/calendar and application/calendar+json media types can | <td align="left"> | |||
use this as an alternative. Similarly, applications that use the application/js | <xref target="type-Link" format="default"/></td> | |||
on media type to transfer calendaring data can use this to further specify the c | </tr> | |||
ontent.</t> | <tr> | |||
<t hangText="Fragment identifier considerations:">A JSON Pointer fragment id | <td align="left">thumbnail</td> | |||
entifier may be used, as defined in <xref target="RFC6901" />, Section 6.</t> | <td align="left"> | |||
<t hangText="Additional information:"> | <xref target="type-Link" format="default"/></td> | |||
<list style="hanging"> | </tr> | |||
<t hangText="Magic number(s):">N/A</t> | </tbody> | |||
<t hangText="File extensions(s):">N/A</t> | </table></dd> | |||
<t hangText="Macintosh file type code(s):">N/A</t> | </dl> | |||
</list> | <dl spacing="compact" newline="false" indent="20"> | |||
</t> | <dt>Property Name:</dt><dd>features</dd> | |||
<t hangText="Person & email address to contact for further information:" | <dt>Context:</dt><dd>VirtualLocation</dd> | |||
>calsify@ietf.org</t> | <dt>Change Controller:</dt><dd>IETF</dd> | |||
<t hangText="Intended usage:">COMMON</t> | <dt>Initial Contents:</dt><dd> | |||
<t hangText="Restrictions on usage:">N/A</t> | <table anchor="tab-iana-enum-virtualLocation-features" align="left"> | |||
<t hangText="Author:">See the "Author's Address" section of this document.</ | <name>JSCalendar Enum Values for features (Context: VirtualLocation)</name | |||
t> | > | |||
<t hangText="Change controller:">IETF</t> | <thead> | |||
</list></t> | <tr> | |||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">audio</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">chat</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">feed</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">moderator</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">phone</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">screen</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">video</td> | ||||
<td align="left"> | ||||
<xref target="prop-virtualLocations" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>freeBusyStatus</dd> | ||||
<dt>Context:</dt><dd>Event, Task</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-freeBusyStatus" align="left"> | ||||
<name>JSCalendar Enum Values for freeBusyStatus (Context: Event, | ||||
Task)</name> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">free</td> | ||||
<td align="left"> | ||||
<xref target="prop-freeBusyStatus" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">busy</td> | ||||
<td align="left"> | ||||
<xref target="prop-freeBusyStatus" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>kind</dd> | ||||
<dt>Context:</dt><dd>Participant</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-participant-kind" align="left"> | ||||
<name>JSCalendar Enum Values for kind (Context: Participant)</nam | ||||
e> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">individual</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">group</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">resource</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">location</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>participationStatus</dd> | ||||
<dt>Context:</dt><dd>Participant</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-participationStatus" align="left"> | ||||
<name>JSCalendar Enum Values for participationStatus (Context: Pa | ||||
rticipant)</name> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">needs-action</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">accepted</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">declined</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">tentative</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">delegated</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>privacy</dd> | ||||
<dt>Context:</dt><dd>Event, Task</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-privacy" align="left"> | ||||
<name>JSCalendar Enum Values for privacy (Context: Event, Task)</ | ||||
name> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">public</td> | ||||
<td align="left"> | ||||
<xref target="prop-privacy" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">private</td> | ||||
<td align="left"> | ||||
<xref target="prop-privacy" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">secret</td> | ||||
<td align="left"> | ||||
<xref target="prop-privacy" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>progress</dd> | ||||
<dt>Context:</dt><dd>Task, Participant</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-status-jstask" align="left"> | ||||
<name>JSCalendar Enum Values for progress (Context: Task, Partici | ||||
pant)</name> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">needs-action</td> | ||||
<td align="left"> | ||||
<xref target="prop-progress" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">in-process</td> | ||||
<td align="left"> | ||||
<xref target="prop-progress" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">completed</td> | ||||
<td align="left"> | ||||
<xref target="prop-progress" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">failed</td> | ||||
<td align="left"> | ||||
<xref target="prop-progress" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">cancelled</td> | ||||
<td align="left"> | ||||
<xref target="prop-progress" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>relation</dd> | ||||
<dt>Context:</dt><dd>Relation</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-relation" align="left"> | ||||
<name>JSCalendar Enum Values for relation (Context: Relation)</na | ||||
me> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">first</td> | ||||
<td align="left"> | ||||
<xref target="type-Relation" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">next</td> | ||||
<td align="left"> | ||||
<xref target="type-Relation" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">child</td> | ||||
<td align="left"> | ||||
<xref target="type-Relation" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">parent</td> | ||||
<td align="left"> | ||||
<xref target="type-Relation" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>relativeTo</dd> | ||||
<dt>Context:</dt><dd>OffsetTrigger, Location</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-offsetTrigger-relativeTo" align="left"> | ||||
<name>JSCalendar Enum Values for relativeTo (Context: OffsetTrigg | ||||
er, Location)</name> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">start</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">end</td> | ||||
<td align="left"> | ||||
<xref target="prop-alerts" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>roles</dd> | ||||
<dt>Context:</dt><dd>Participant</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-participant-role" align="left"> | ||||
<name>JSCalendar Enum Values for roles (Context: Participant)</na | ||||
me> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">owner</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">attendee</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">optional</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">informational</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">chair</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">contact</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>scheduleAgent</dd> | ||||
<dt>Context:</dt><dd>Participant</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-participant-scheduleagent" align="left"> | ||||
<name>JSCalendar Enum Values for scheduleAgent (Context: Particip | ||||
ant)</name> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">server</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">client</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">none</td> | ||||
<td align="left"> | ||||
<xref target="prop-participants" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
<dl spacing="compact" newline="false" indent="20"> | ||||
<dt>Property Name:</dt><dd>status</dd> | ||||
<dt>Context:</dt><dd>Event</dd> | ||||
<dt>Change Controller:</dt><dd>IETF</dd> | ||||
<dt>Initial Contents:</dt><dd> | ||||
<table anchor="tab-iana-enum-status-jsevent" align="left"> | ||||
<name>JSCalendar Enum Values for status (Context: Event)</name> | ||||
<thead> | ||||
<tr> | ||||
<th align="left">Enum Value</th> | ||||
<th align="left">Reference or Description</th> | ||||
</tr> | ||||
</thead> | ||||
<tbody> | ||||
<tr> | ||||
<td align="left">confirmed</td> | ||||
<td align="left"> | ||||
<xref target="prop-status-jsevent" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">cancelled</td> | ||||
<td align="left"> | ||||
<xref target="prop-status-jsevent" format="default"/></td> | ||||
</tr> | ||||
<tr> | ||||
<td align="left">tentative</td> | ||||
<td align="left"> | ||||
<xref target="prop-status-jsevent" format="default"/></td> | ||||
</tr> | ||||
</tbody> | ||||
</table></dd> | ||||
</dl> | ||||
</section> | </section> | |||
<section anchor="iana-property-registry" title='Creation of "JSCalendar Properti | ||||
es" Registry'> | ||||
<t>The IANA will create the "JSCalendar Properties" registry to allow interope | ||||
rability of extensions to JSCalendar objects.</t> | ||||
<t>This registry follows the Expert Review process (<xref target="RFC8126"/>, | ||||
Section 4.5). If the "intended use" field is <spanx style="verb">commo | ||||
n</spanx>, sufficient documentation is required to enable interoperability. Prel | ||||
iminary community review for this registry is optional but strongly encouraged.< | ||||
/t> | ||||
<t>A registration can have an intended use of <spanx style="verb">common</span | ||||
x>, <spanx style="verb">reserved</spanx>, or <spanx style="verb">obsolete</spanx | ||||
>. The IANA will list common-use registrations prominently and separately from t | ||||
hose with other intended use values.</t> | ||||
<t>A <spanx style="verb">reserved</spanx> registration reserves a property nam | ||||
e without assigning semantics to avoid name collisions with future extensions or | ||||
protocol use.</t> | ||||
<t>An <spanx style="verb">obsolete</spanx> registration denotes a property tha | ||||
t is no longer expected to be added by up-to-date systems. A new property has pr | ||||
obably been defined covering the obsolete property's semantics.</t> | ||||
<t>The JSCalendar property registration procedure is not a formal standards pr | ||||
ocess but rather an administrative procedure intended to allow community comment | ||||
and sanity checking without excessive time delay. It is designed to encourage v | ||||
endors to document and register new properties they add for use cases not covere | ||||
d by the original specification, leading to increased interoperability.</t> | ||||
<section anchor="iana-property-registry-preliminary-community-review" title="P | ||||
reliminary Community Review"> | ||||
<t>Notice of a potential new registration SHOULD be sent to the Calext maili | ||||
ng list <calsify@ietf.org> for review. This mailing list is appropriate to | ||||
solicit community feedback on a proposed new property.</t> | ||||
<t>Properties registrations must be marked with their intended use: "common" | ||||
, "reserved" or "obsolete".</t> | ||||
<t>The intent of the public posting to this list is to solicit comments and | ||||
feedback on the choice of the property name, the unambiguity of the specificatio | ||||
n document, and a review of any interoperability or security considerations. The | ||||
submitter may submit a revised registration proposal or abandon the registratio | ||||
n completely at any time.</t> | ||||
</section> | ||||
<section anchor="iana-property-registry-submit-request-to-iana" title="Submit | ||||
Request to IANA"> | ||||
<t>Registration requests can be sent to <iana@iana.org>.</t> | ||||
</section> | ||||
<section anchor="iana-property-registry-designated-expert-review" title="Desig | ||||
nated Expert Review"> | ||||
<t>The primary concern of the designated expert (DE) is preventing name coll | ||||
isions and encouraging the submitter to document security and privacy considerat | ||||
ions. For a common-use registration, the DE is expected to confirm that suitable | ||||
documentation, as described in Section 4.6 of <xref target="RFC8126"/>, is avai | ||||
lable to ensure interoperability. That documentation will usually be in an RFC, | ||||
but simple definitions are likely to use a web/wiki page, and if a sentence or t | ||||
wo is deemed sufficient it could be described in the registry itself. The DE sho | ||||
uld also verify that the property name does not conflict with work that is activ | ||||
e or already published within the IETF. A published specification is not require | ||||
d for reserved or obsolete registrations.</t> | ||||
<t>The DE will either approve or deny the registration request and publish a | ||||
notice of the decision to the Calext WG mailing list or its successor, as well | ||||
as inform IANA. A denial notice must be justified by an explanation, and, in the | ||||
cases where it is possible, concrete suggestions on how the request can be modi | ||||
fied so as to become acceptable should be provided.</t> | ||||
</section> | ||||
<section anchor="iana-property-registry-change-procedures" title="Change Proce | ||||
dures"> | ||||
<t>Once a JSCalendar property has been published by the IANA, the change con | ||||
troller may request a change to its definition. The same procedure that would be | ||||
appropriate for the original registration request is used to process a change r | ||||
equest.</t> | ||||
<t>JSCalendar property registrations may not be deleted; properties that are | ||||
no longer believed appropriate for use can be declared obsolete by a change to | ||||
their "intended use" field; such properties will be clearly marked in | ||||
the lists published by the IANA.</t> | ||||
<t>Significant changes to a JSCalendar property's definition should be reque | ||||
sted only when there are serious omissions or errors in the published specificat | ||||
ion, as such changes may cause interoperability issues. When review is required, | ||||
a change request may be denied if it renders entities that were valid under the | ||||
previous definition invalid under the new definition.</t> | ||||
<t>The owner of a JSCalendar property may pass responsibility to another per | ||||
son or agency by informing the IANA; this can be done without discussion or revi | ||||
ew.</t> | ||||
</section> | ||||
<section anchor="iana-property-registry-template" title="JSCalendar Properties | ||||
Registry Template"> | ||||
<t><list style="symbols"> | ||||
<t>Property Name: The name of the property. The property name MUST NOT alr | ||||
eady be registered for any of the object types listed in the "Property Context" | ||||
field of this registration. Other object types MAY already have registered a dif | ||||
ferent property with the same name, however the same name SHOULD only be used wh | ||||
en the semantics are analogous.</t> | ||||
<t>Property Type: The type of this property, using type signatures as spec | ||||
ified in <xref target="type-signatures"/>. The property type MUST be registed in | ||||
the Type Registry.</t> | ||||
<t>Property Context: A comma-separated list of JSCalendar object types thi | ||||
s property is allowed on.</t> | ||||
<t>Reference or Description: A brief description or RFC number and section | ||||
reference where the property is specified (omitted for "reserved" property name | ||||
s).</t> | ||||
<t>Intended Use: Common, reserved, or obsolete.</t> | ||||
<t>Change Controller: Who may request a change to this entry's definition | ||||
(<spanx style="verb">IETF</spanx> for IETF-stream RFCs).</t> | ||||
</list></t> | ||||
</section> | ||||
<section anchor="iana-property-registry-contents" title="Initial Contents for | ||||
the JSCalendar Properties Registry"> | ||||
<t>The following table lists the initial entries of the JSCalendar Propertie | ||||
s registry. All properties are for common-use. All RFC section references are fo | ||||
r this document. The change controller for all these properties is "IETF".</t> | ||||
<texttable anchor="table-iana-property-registry"> | ||||
<ttcol align='left'>Property Name</ttcol> | ||||
<ttcol align='left'>Property Type</ttcol> | ||||
<ttcol align='left'>Property Context</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>@type</c> | ||||
<c>String</c> | ||||
<c>JSEvent, JSTask, JSGroup, AbsoluteTrigger, Alert, Link, Location, NDay, | ||||
OffsetTrigger, Participant, RecurrenceRule, Relation, TimeZone, TimeZoneRule, V | ||||
irtualLocation</c> | ||||
<c><xref target="prop-type"/>, <xref target="prop-alerts"/>, <xref target= | ||||
"type-Link"/>, <xref target="prop-locations"/>, <xref target="prop-participants" | ||||
/>, <xref target="prop-recurrenceRules"/>, <xref target="prop-relatedTo"/>, <xre | ||||
f target="prop-timeZones"/>, <xref target="prop-timeZones"/>, <xref target="prop | ||||
-virtualLocations"/></c> | ||||
<c>acknowledged</c> | ||||
<c>UTCDateTime</c> | ||||
<c>Alert</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
<c>action</c> | ||||
<c>String</c> | ||||
<c>Alert</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
<c>alerts</c> | ||||
<c>Id[Alert]</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
<c>aliases</c> | ||||
<c>String[Boolean]</c> | ||||
<c>TimeZone</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>byDay</c> | ||||
<c>NDay[]</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>byHour</c> | ||||
<c>UnsignedInt[]</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>byMinute</c> | ||||
<c>UnsignedInt[]</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>byMonth</c> | ||||
<c>String[]</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>byMonthDay</c> | ||||
<c>Int[]</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>bySecond</c> | ||||
<c>UnsignedInt[]</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>bySetPosition</c> | ||||
<c>Int[]</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>byWeekNo</c> | ||||
<c>Int[]</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>byYearDay</c> | ||||
<c>Int[]</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>categories</c> | ||||
<c>String[Boolean]</c> | ||||
<c>JSEvent, JSTask, JSGroup</c> | ||||
<c><xref target="prop-categories"/></c> | ||||
<c>cid</c> | ||||
<c>String</c> | ||||
<c>Link</c> | ||||
<c><xref target="type-Link"/></c> | ||||
<c>color</c> | ||||
<c>String</c> | ||||
<c>JSEvent, JSTask, JSGroup</c> | ||||
<c><xref target="prop-color"/></c> | ||||
<c>comments</c> | ||||
<c>String[]</c> | ||||
<c>TimeZoneRule</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>contentType</c> | ||||
<c>String</c> | ||||
<c>Link</c> | ||||
<c><xref target="type-Link"/></c> | ||||
<c>coordinates</c> | ||||
<c>String</c> | ||||
<c>Location</c> | ||||
<c><xref target="prop-locations"/></c> | ||||
<c>count</c> | ||||
<c>UnsignedInt</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>created</c> | ||||
<c>UTCDateTime</c> | ||||
<c>JSEvent, JSTask, JSGroup</c> | ||||
<c><xref target="prop-created"/></c> | ||||
<c>day</c> | ||||
<c>String</c> | ||||
<c>NDay</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>daylight</c> | ||||
<c>TimeZoneRule</c> | ||||
<c>TimeZone</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>delegatedFrom</c> | ||||
<c>String[Boolean]</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>delegatedTo</c> | ||||
<c>String[Boolean]</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>description</c> | ||||
<c>String</c> | ||||
<c>JSEvent, JSTask, Location, Participant, VirtualLocation</c> | ||||
<c><xref target="prop-description"/>, <xref target="prop-locations"/>, <xr | ||||
ef target="prop-participants"/>, <xref target="prop-virtualLocations"/></c> | ||||
<c>descriptionContentType</c> | ||||
<c>String</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-descriptionContentType"/></c> | ||||
<c>display</c> | ||||
<c>String</c> | ||||
<c>Link</c> | ||||
<c><xref target="type-Link"/></c> | ||||
<c>due</c> | ||||
<c>LocalDateTime</c> | ||||
<c>JSTask</c> | ||||
<c><xref target="prop-due"/></c> | ||||
<c>duration</c> | ||||
<c>Duration</c> | ||||
<c>JSEvent</c> | ||||
<c><xref target="prop-duration"/></c> | ||||
<c>email</c> | ||||
<c>String</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>entries</c> | ||||
<c>(JSTask|JSEvent)[]</c> | ||||
<c>JSGroup</c> | ||||
<c><xref target="prop-entries"/></c> | ||||
<c>estimatedDuration</c> | ||||
<c>Duration</c> | ||||
<c>JSTask</c> | ||||
<c><xref target="prop-estimatedDuration"/></c> | ||||
<c>excluded</c> | ||||
<c>Boolean</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-excluded"/></c> | ||||
<c>excludedRecurrenceRules</c> | ||||
<c>RecurrenceRule[]</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-excludedRecurrenceRules"/></c> | ||||
<c>expectReply</c> | ||||
<c>Boolean</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>firstDayOfWeek</c> | ||||
<c>String</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>freeBusyStatus</c> | ||||
<c>String</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-freeBusyStatus"/></c> | ||||
<c>frequency</c> | ||||
<c>String</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>href</c> | ||||
<c>String</c> | ||||
<c>Link</c> | ||||
<c><xref target="type-Link"/></c> | ||||
<c>interval</c> | ||||
<c>UnsignedInt</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>invitedBy</c> | ||||
<c>String</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>keywords</c> | ||||
<c>String[Boolean]</c> | ||||
<c>JSEvent, JSTask, JSGroup</c> | ||||
<c><xref target="prop-keywords"/></c> | ||||
<c>kind</c> | ||||
<c>String</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>language</c> | ||||
<c>String</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>links</c> | ||||
<c>Id[Link]</c> | ||||
<c>JSGroup, JSEvent, JSTask, Location, Participant</c> | ||||
<c><xref target="prop-links"/>, <xref target="prop-locations"/>, <xref tar | ||||
get="prop-participants"/></c> | ||||
<c>locale</c> | ||||
<c>String</c> | ||||
<c>JSGroup, JSEvent, JSTask</c> | ||||
<c><xref target="prop-locale"/></c> | ||||
<c>localizations</c> | ||||
<c>String[PatchObject]</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-localizations"/></c> | ||||
<c>locationId</c> | ||||
<c>String</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>locations</c> | ||||
<c>Id[Location]</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-locations"/></c> | ||||
<c>locationTypes</c> | ||||
<c>String[Boolean]</c> | ||||
<c>Location</c> | ||||
<c><xref target="prop-locations"/></c> | ||||
<c>memberOf</c> | ||||
<c>String[Boolean]</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>method</c> | ||||
<c>String</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-method"/></c> | ||||
<c>name</c> | ||||
<c>String</c> | ||||
<c>Location, VirtualLocation, Participant</c> | ||||
<c><xref target="prop-locations"/>, <xref target="prop-virtualLocations"/> | ||||
, <xref target="prop-participants"/></c> | ||||
<c>names</c> | ||||
<c>String[Boolean]</c> | ||||
<c>TimeZoneRule</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>nthOfPeriod</c> | ||||
<c>Int</c> | ||||
<c>NDay</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>offset</c> | ||||
<c>SignedDuration</c> | ||||
<c>OffsetTrigger</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
<c>offsetFrom</c> | ||||
<c>UTCDateTime</c> | ||||
<c>TimeZoneRule</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>offsetTo</c> | ||||
<c>UTCDateTime</c> | ||||
<c>TimeZoneRule</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>participants</c> | ||||
<c>Id[Participant]</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>participationComment</c> | ||||
<c>String</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>participationStatus</c> | ||||
<c>String</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>percentComplete</c> | ||||
<c>UnsignedInt</c> | ||||
<c>JSTask, Participant</c> | ||||
<c><xref target="prop-percentComplete"/></c> | ||||
<c>priority</c> | ||||
<c>Int</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-priority"/></c> | ||||
<c>privacy</c> | ||||
<c>String</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-privacy"/></c> | ||||
<c>prodId</c> | ||||
<c>String</c> | ||||
<c>JSEvent, JSTask, JSGroup</c> | ||||
<c><xref target="prop-prodId"/></c> | ||||
<c>progress</c> | ||||
<c>String</c> | ||||
<c>JSTask, Participant</c> | ||||
<c><xref target="prop-progress"/></c> | ||||
<c>progressUpdated</c> | ||||
<c>UTCDateTime</c> | ||||
<c>JSTask, Participant</c> | ||||
<c><xref target="prop-progressUpdated"/></c> | ||||
<c>recurrenceId</c> | ||||
<c>LocalDateTime</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-recurrenceId"/></c> | ||||
<c>recurrenceOverrides</c> | ||||
<c>LocalDateTime[PatchObject]</c> | ||||
<c>JSEvent, JSTask, TimeZoneRule</c> | ||||
<c><xref target="prop-recurrenceOverrides"/>, <xref target="prop-timeZones | ||||
"/></c> | ||||
<c>recurrenceRules</c> | ||||
<c>RecurrenceRule[]</c> | ||||
<c>JSEvent, JSTask, TimeZoneRule</c> | ||||
<c><xref target="prop-recurrenceRules"/>, <xref target="prop-timeZones"/>< | ||||
/c> | ||||
<c>rel</c> | ||||
<c>String</c> | ||||
<c>Link</c> | ||||
<c><xref target="type-Link"/></c> | ||||
<c>relatedTo</c> | ||||
<c>String[Relation]</c> | ||||
<c>JSEvent, JSTask, Alert</c> | ||||
<c><xref target="prop-relatedTo"/>, <xref target="prop-alerts"/></c> | ||||
<c>relation</c> | ||||
<c>String[Boolean]</c> | ||||
<c>Relation</c> | ||||
<c><xref target="type-Relation"/></c> | ||||
<c>relativeTo</c> | ||||
<c>String</c> | ||||
<c>OffsetTrigger, Location</c> | ||||
<c><xref target="prop-alerts"/>, <xref target="prop-locations"/></c> | ||||
<c>replyTo</c> | ||||
<c>String[String]</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-replyTo"/></c> | ||||
<c>roles</c> | ||||
<c>String[Boolean]</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>rscale</c> | ||||
<c>String</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>standard</c> | ||||
<c>TimeZoneRule</c> | ||||
<c>TimeZone</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>start</c> | ||||
<c>LocalDateTime</c> | ||||
<c>TimeZoneRule</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>scheduleAgent</c> | ||||
<c>String</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>scheduleForceSend</c> | ||||
<c>Boolean</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>scheduleSequence</c> | ||||
<c>UnsignedInt</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>scheduleStatus</c> | ||||
<c>String[]</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>scheduleUpdated</c> | ||||
<c>UTCDateTime</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>sendTo</c> | ||||
<c>String[String]</c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>sequence</c> | ||||
<c>UnsignedInt</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-sequence"/></c> | ||||
<c>showWithoutTime</c> | ||||
<c>Boolean</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-showWithoutTime"/></c> | ||||
<c>size</c> | ||||
<c>UnsignedInt</c> | ||||
<c>Link</c> | ||||
<c><xref target="type-Link"/></c> | ||||
<c>skip</c> | ||||
<c>String</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>source</c> | ||||
<c>String</c> | ||||
<c>JSGroup</c> | ||||
<c><xref target="prop-source"/></c> | ||||
<c>start</c> | ||||
<c>LocalDateTime</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-start-jsevent"/>, <xref target="prop-start-jstask"/> | ||||
</c> | ||||
<c>status</c> | ||||
<c>String</c> | ||||
<c>JSEvent</c> | ||||
<c><xref target="prop-status-jsevent"/></c> | ||||
<c>timeZone</c> | ||||
<c>TimeZoneId|null</c> | ||||
<c>JSEvent, JSTask, Location</c> | ||||
<c><xref target="prop-timeZone"/>, <xref target="prop-locations"/></c> | ||||
<c>timeZones</c> | ||||
<c>TimeZoneId[TimeZone]</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>title</c> | ||||
<c>String</c> | ||||
<c>JSEvent, JSTask, JSGroup, Link</c> | ||||
<c><xref target="prop-title"/></c> | ||||
<c>trigger</c> | ||||
<c>OffsetTrigger|AbsoluteTrigger|UnknownTrigger</c> | ||||
<c>Alert</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
<c>tzId</c> | ||||
<c>String</c> | ||||
<c>TimeZone</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>uid</c> | ||||
<c>String</c> | ||||
<c>JSEvent, JSTask, JSGroup</c> | ||||
<c><xref target="prop-uid"/></c> | ||||
<c>until</c> | ||||
<c>LocalDateTime</c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>updated</c> | ||||
<c>UTCDateTime</c> | ||||
<c>JSEvent, JSTask, JSGroup</c> | ||||
<c><xref target="prop-updated"/></c> | ||||
<c>uri</c> | ||||
<c>String</c> | ||||
<c>VirtualLocation</c> | ||||
<c><xref target="prop-virtualLocations"/></c> | ||||
<c>url</c> | ||||
<c>String</c> | ||||
<c>TimeZone</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>useDefaultAlerts</c> | ||||
<c>Boolean</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="useDefaultAlerts"/></c> | ||||
<c>validUntil</c> | ||||
<c>UTCDateTime</c> | ||||
<c>TimeZone</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>virtualLocations</c> | ||||
<c>Id[VirtualLocation]</c> | ||||
<c>JSEvent, JSTask</c> | ||||
<c><xref target="prop-virtualLocations"/></c> | ||||
<c>when</c> | ||||
<c>UTCDateTime</c> | ||||
<c>AbsoluteTrigger</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
</texttable> | ||||
</section> | ||||
</section> | </section> | |||
<section anchor="iana-type-registry" title='Creation of "JSCalendar Types" Regis | ||||
try'> | ||||
<t>The IANA will create the "JSCalendar Types" registry to avoid name collisio | ||||
ns and provide a complete reference for all data types used for JSCalendar prope | ||||
rty values. The registration process is the same as for the JSCalendar Propertie | ||||
s registry, as defined in <xref target="iana-property-registry"/>.</t> | ||||
<section anchor="iana-type-registry-template" title="JSCalendar Types Registry | ||||
Template"> | ||||
<t><list style="symbols"> | ||||
<t>Type Name: The name of the type.</t> | ||||
<t>Reference or Description: A brief description or RFC number and section | ||||
reference where the Type is specified (may be omitted for "reserved" type names | ||||
).</t> | ||||
<t>Intended Use: Common, reserved, or obsolete.</t> | ||||
<t>Change Controller: Who may request a change to this entry's definition | ||||
(<spanx style="verb">IETF</spanx> for IETF-stream RFCs).</t> | ||||
</list></t> | ||||
</section> | ||||
<section anchor="iana-type-registry-contents" title="Initial Contents for the | ||||
JSCalendar Types Registry"> | ||||
<t>The following table lists the initial entries of the JSCalendar Types reg | ||||
istry. All properties are for common-use. All RFC section references are for thi | ||||
s document. The change controller for all these properties is "IETF".</t> | ||||
<texttable anchor="table-iana-type-registry"> | ||||
<ttcol align='left'>Type Name</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>Alert</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
<c>Boolean</c> | ||||
<c><xref target="type-signatures"/></c> | ||||
<c>Duration</c> | ||||
<c><xref target="type-Duration"/></c> | ||||
<c>Id</c> | ||||
<c><xref target="type-Id"/></c> | ||||
<c>Int</c> | ||||
<c><xref target="type-Int"/></c> | ||||
<c>LocalDateTime</c> | ||||
<c><xref target="type-LocalDateTime"/></c> | ||||
<c>Link</c> | ||||
<c><xref target="type-Link"/></c> | ||||
<c>Location</c> | ||||
<c><xref target="prop-locations"/></c> | ||||
<c>NDay</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>Number</c> | ||||
<c><xref target="type-signatures"/></c> | ||||
<c>Participant</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>PatchObject</c> | ||||
<c><xref target="type-PatchObject"/></c> | ||||
<c>RecurrenceRule</c> | ||||
<c><xref target="prop-recurrenceRules"/></c> | ||||
<c>Relation</c> | ||||
<c><xref target="type-Relation"/></c> | ||||
<c>SignedDuration</c> | ||||
<c><xref target="type-SignedDuration"/></c> | ||||
<c>String</c> | ||||
<c><xref target="type-signatures"/></c> | ||||
<c>TimeZone</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>TimeZoneId</c> | ||||
<c><xref target="type-timeZoneId"/></c> | ||||
<c>TimeZoneRule</c> | ||||
<c><xref target="prop-timeZones"/></c> | ||||
<c>UnsignedInt</c> | ||||
<c><xref target="type-UnsignedInt"/></c> | ||||
<c>UTCDateTime</c> | ||||
<c><xref target="type-UTCDateTime"/></c> | ||||
<c>VirtualLocation</c> | ||||
<c><xref target="prop-virtualLocations"/></c> | ||||
</texttable> | ||||
</section> | ||||
</section> | </section> | |||
</middle> | ||||
<back> | ||||
<references> | ||||
<name>References</name> | ||||
<references> | ||||
<name>Normative References</name> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.2119.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.2392.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.2397.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.3339.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.3986.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.4122.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.4589.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.4648.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.5234.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.5322.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.5545.xml"/> | ||||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.5546.xml"/> | ||||
<section anchor="iana-enum-registry" title='Creation of "JSCalendar Enum Values" | <referencegroup anchor="BCP47" target="https://www.rfc-editor.org/info/bcp47"> | |||
Registry'> | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.564 | |||
<t>The IANA will create the "JSCalendar Enum Values" registry to allow interop | 6.xml"/> | |||
erable extension of semantics for properties with enumerable values. Each such p | </referencegroup> | |||
roperty will have a subregistry of allowed values. The registration process for | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
a new enum value or adding a new enumerable property is the same as for the JSCa | FC.5870.xml"/> | |||
lendar Properties registry, as defined in <xref target="iana-property-registry"/ | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
>.</t> | FC.6047.xml"/> | |||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
<section anchor="iana-enum-registry-registry-template" title="JSCalendar Enum | FC.6838.xml"/> | |||
Property Template"> | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
<t>This template is for adding a subregistry for a new enumerable property t | FC.6901.xml"/> | |||
o the JSCalendar Enum registry.</t> | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
FC.7493.xml"/> | ||||
<t><list style="symbols"> | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
<t>Property Name: the name(s) of the property or properties where these va | FC.7529.xml"/> | |||
lues may be used. This MUST be registered in the JSCalendar Properties registry. | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
</t> | FC.7808.xml"/> | |||
<t>Context: the list of allowed object types where the property or propert | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
ies may appear, as registered in the JSCalendar Properties registry. This disamb | FC.8126.xml"/> | |||
iguates where there may be two distinct properties with the same name in differe | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
nt contexts.</t> | FC.8174.xml"/> | |||
<t>Change Controller: (<spanx style="verb">IETF</spanx> for properties def | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
ined in IETF-stream RFCs).</t> | FC.8259.xml"/> | |||
<t>Initial Contents: The initial list of defined values for this enum, usi | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
ng the template defined in <xref target="iana-enum-registry-value-template"/>. A | FC.8288.xml"/> | |||
subregistry will be created with these values for this property name/context tu | ||||
ple.</t> | ||||
</list></t> | ||||
</section> | ||||
<section anchor="iana-enum-registry-value-template" title="JSCalendar Enum Val | ||||
ue Template"> | ||||
<t>This template is for adding a new enum value to a subregistry in the JSCa | ||||
lendar Enum registry.</t> | ||||
<t><list style="symbols"> | ||||
<t>Enum Value: The verbatim value of the enum.</t> | ||||
<t>Reference or Description: A brief description or RFC number and section | ||||
reference for the semantics of this value.</t> | ||||
</list></t> | ||||
</section> | ||||
<section anchor="iana-enum-registry-contents" title="Initial Contents for the | ||||
JSCalendar Enum Values registry"> | ||||
<t>For each subregistry created in this section, all RFC section references | ||||
are for this document.</t> | ||||
<t>------------------------------------------------------------</t> | ||||
<t>Property Name: action</t> | ||||
<t>Context: Alert</t> | ||||
<t>Change Controller: IETF</t> | ||||
<t>Initial Contents:</t> | ||||
<texttable anchor="table-iana-enum-alert-action"> | ||||
<ttcol align='left'>Enum Value</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>display</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
<c>email</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | ||||
<t>Property Name: display</t> | ||||
<t>Context: Link</t> | ||||
<t>Change Controller: IETF</t> | ||||
<t>Initial Contents:</t> | ||||
<texttable anchor="table-iana-enum-link-display"> | ||||
<ttcol align='left'>Enum Value</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>badge</c> | ||||
<c><xref target="type-Link"/></c> | ||||
<c>graphic</c> | ||||
<c><xref target="type-Link"/></c> | ||||
<c>fullsize</c> | ||||
<c><xref target="type-Link"/></c> | ||||
<c>thumbnail</c> | ||||
<c><xref target="type-Link"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | ||||
<t>Property Name: freeBusyStatus</t> | ||||
<t>Context: JSEvent, JSTask</t> | ||||
<t>Change Controller: IETF</t> | ||||
<t>Initial Contents:</t> | ||||
<texttable anchor="table-iana-enum-freeBusyStatus"> | ||||
<ttcol align='left'>Enum Value</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>free</c> | ||||
<c><xref target="prop-freeBusyStatus"/></c> | ||||
<c>busy</c> | ||||
<c><xref target="prop-freeBusyStatus"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | ||||
<t>Property Name: kind</t> | ||||
<t>Context: Participant</t> | ||||
<t>Change Controller: IETF</t> | ||||
<t>Initial Contents:</t> | ||||
<texttable anchor="table-iana-enum-participant-kind"> | ||||
<ttcol align='left'>Enum Value</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>individual</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>group</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>resource</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>location</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | ||||
<t>Property Name: participationStatus</t> | ||||
<t>Context: Participant</t> | ||||
<t>Change Controller: IETF</t> | ||||
<t>Initial Contents:</t> | ||||
<texttable anchor="table-iana-enum-participationStatus"> | ||||
<ttcol align='left'>Enum Value</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>needs-action</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>accepted</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>declined</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>tenative</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>delegated</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | ||||
<t>Property Name: privacy</t> | ||||
<t>Context: JSEvent, JSTask</t> | ||||
<t>Change Controller: IETF</t> | ||||
<t>Initial Contents:</t> | ||||
<texttable anchor="table-iana-enum-privacy"> | ||||
<ttcol align='left'>Enum Value</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>public</c> | ||||
<c><xref target="prop-privacy"/></c> | ||||
<c>private</c> | ||||
<c><xref target="prop-privacy"/></c> | ||||
<c>secret</c> | ||||
<c><xref target="prop-privacy"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | ||||
<t>Property Name: progress</t> | ||||
<t>Context: JSTask, Participant</t> | ||||
<t>Change Controller: IETF</t> | ||||
<t>Initial Contents:</t> | ||||
<texttable anchor="table-iana-enum-status-jstask"> | ||||
<ttcol align='left'>Enum Value</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>needs-action</c> | ||||
<c><xref target="prop-progress"/></c> | ||||
<c>in-process</c> | ||||
<c><xref target="prop-progress"/></c> | ||||
<c>completed</c> | ||||
<c><xref target="prop-progress"/></c> | ||||
<c>failed</c> | ||||
<c><xref target="prop-progress"/></c> | ||||
<c>cancelled</c> | ||||
<c><xref target="prop-progress"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | ||||
<t>Property Name: relation</t> | ||||
<t>Context: Relation</t> | ||||
<t>Change Controller: IETF</t> | ||||
<t>Initial Contents:</t> | ||||
<texttable anchor="table-iana-enum-relation"> | ||||
<ttcol align='left'>Enum Value</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>first</c> | ||||
<c><xref target="type-Relation"/></c> | ||||
<c>next</c> | ||||
<c><xref target="type-Relation"/></c> | ||||
<c>child</c> | ||||
<c><xref target="type-Relation"/></c> | ||||
<c>parent</c> | ||||
<c><xref target="type-Relation"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | ||||
<t>Property Name: relativeTo</t> | ||||
<t>Context: OffsetTrigger, Location</t> | ||||
<t>Change Controller: IETF</t> | ||||
<t>Initial Contents:</t> | ||||
<texttable anchor="table-iana-enum-offsetTrigger-relativeTo"> | ||||
<ttcol align='left'>Enum Value</ttcol> | ||||
<ttcol align='left'>Reference or Description</ttcol> | ||||
<c>start</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
<c>end</c> | ||||
<c><xref target="prop-alerts"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | ||||
<t>Property Name: roles</t> | ||||
<t>Context: Participant</t> | ||||
<t>Change Controller: IETF</t> | ||||
<t>Initial Contents:</t> | ||||
<texttable anchor="table-iana-enum-participant-role"> | <reference anchor="CLDR" target="http://cldr.unicode.org/"> | |||
<ttcol align='left'>Enum Value</ttcol> | <front> | |||
<ttcol align='left'>Reference or Description</ttcol> | <title>Unicode Common Locale Data Repository</title> | |||
<c>owner</c> | <author/> | |||
<c><xref target="prop-participants"/></c> | <date/> | |||
<c>attendee</c> | </front> | |||
<c><xref target="prop-participants"/></c> | </reference> | |||
<c>optional</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>informational</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>chair</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
<c>contact</c> | ||||
<c><xref target="prop-participants"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | <reference anchor="TZDB" target="https://www.iana.org/time-zones"> | |||
<front> | ||||
<title>Time Zone Database</title> | ||||
<author><organization>IANA</organization></author> | ||||
<date/> | ||||
</front> | ||||
</reference> | ||||
<t>Property Name: scheduleAgent</t> | <reference anchor="COLORS" target="https://www.w3.org/TR/css-color-3/"> | |||
<t>Context: Participant</t> | <front> | |||
<t>Change Controller: IETF</t> | <title>CSS Color Module Level 3</title> | |||
<t>Initial Contents:</t> | <author initials='T' surname='Çelik' fullname='Tantek Çelik'> | |||
<organization /> | ||||
</author> | ||||
<author initials='C' surname='Lilley' fullname='Chris Lilley'> | ||||
<organization /> | ||||
</author> | ||||
<author initials='L' surname='Baron' fullname='L. David Baron'> | ||||
<organization /> | ||||
</author> | ||||
<date month="June" year="2018"/> | ||||
</front> | ||||
<refcontent>W3C Recommendation</refcontent> | ||||
</reference> | ||||
</references> | ||||
<references> | ||||
<name>Informative References</name> | ||||
<texttable anchor="table-iana-enum-participant-scheduleagent"> | <reference anchor="ISO.9070.1991" target="https://www.iso.org/standard/16645. | |||
<ttcol align='left'>Enum Value</ttcol> | html"> | |||
<ttcol align='left'>Reference or Description</ttcol> | <front> | |||
<c>server</c> | <title>Information technology -- SGML support facilities -- Registration | |||
<c><xref target="prop-participants"/></c> | procedures for public text owner identifiers</title> | |||
<c>client</c> | <author> | |||
<c><xref target="prop-participants"/></c> | <organization>ISO/IEC</organization> | |||
<c>none</c> | </author> | |||
<c><xref target="prop-participants"/></c> | ||||
</texttable> | ||||
<t>------------------------------------------------------------</t> | <date month="April" year="1991"/> | |||
</front> | ||||
<seriesInfo name="ISO/IEC" value="9070:1991"/> | ||||
<seriesInfo name="Edition" value="2"/> | ||||
</reference> | ||||
<t>Property Name: status</t> | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
<t>Context: JSEvent</t> | FC.6376.xml"/> | |||
<t>Change Controller: IETF</t> | <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | |||
<t>Initial Contents:</t> | FC.7265.xml"/> | |||
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.R | ||||
FC.7986.xml"/> | ||||
<texttable anchor="table-iana-enum-status-jsevent"> | <reference anchor="LOCATIONTYPES" target="https://www.iana.org/assignmen | |||
<ttcol align='left'>Enum Value</ttcol> | ts/location-type-registry"> | |||
<ttcol align='left'>Reference or Description</ttcol> | <front> | |||
<c>confirmed</c> | <title>Location Types Registry</title> | |||
<c><xref target="prop-status-jsevent"/></c> | <author><organization>IANA</organization></author> | |||
<c>cancelled</c> | </front> | |||
<c><xref target="prop-status-jsevent"/></c> | </reference> | |||
<c>tentative</c> | ||||
<c><xref target="prop-status-jsevent"/></c> | ||||
</texttable> | ||||
</section> | <reference anchor="LINKRELS" target="https://www.iana.org/assignments/li | |||
</section> | nk-relations"> | |||
</section> | <front> | |||
<title>Link Relations: Link Relation Types</title> | ||||
<author><organization>IANA</organization></author> | ||||
</front> | ||||
</reference> | ||||
<section anchor="acknowledgments" title="Acknowledgments"> | <reference anchor="MEDIATYPES" target="https://www.iana.org/assignments/ | |||
<t>The authors would like to thank the members of CalConnect for their val | media-types"> | |||
uable contributions. This specification originated from the work of the API tech | <front> | |||
nical committee of CalConnect, the Calendaring and Scheduling Consortium.</t> | <title>Media Types</title> | |||
</section> | <author><organization>IANA</organization></author> | |||
</middle> | </front> | |||
<back> | </reference> | |||
<references title="Normative References"> | </references> | |||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.211 | ||||
9.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.239 | ||||
2.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.239 | ||||
7.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.333 | ||||
9.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.398 | ||||
6.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.412 | ||||
2.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.458 | ||||
9.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.464 | ||||
8.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.523 | ||||
4.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.554 | ||||
5.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.554 | ||||
6.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.564 | ||||
6.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.587 | ||||
0.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.604 | ||||
7.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.683 | ||||
8.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.690 | ||||
1.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.749 | ||||
3.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.752 | ||||
9.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.780 | ||||
8.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.812 | ||||
6.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.817 | ||||
4.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.825 | ||||
9.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.828 | ||||
8.xml"?> | ||||
<reference anchor="CLDR" target="http://cldr.unicode.org/"> | ||||
<front> | ||||
<title>Unicode Common Locale Data Repository</title> | ||||
<author /> | ||||
<date /> | ||||
</front> | ||||
</reference> | ||||
<reference anchor="TZDB" target="https://www.iana.org/time-zones"> | ||||
<front> | ||||
<title>IANA Time Zone Database</title> | ||||
<author /> | ||||
<date /> | ||||
</front> | ||||
</reference> | ||||
<reference anchor="COLORS" target="https://www.w3.org/TR/css-color-3/"> | ||||
<front> | ||||
<title>CSS Color Module</title> | ||||
<author /> | ||||
<date /> | ||||
</front> | ||||
</reference> | ||||
</references> | ||||
<references title="Informative References"> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.637 | ||||
6.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.726 | ||||
5.xml"?> | ||||
<?rfc include="http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.798 | ||||
6.xml"?> | ||||
<reference anchor="LOCATIONTYPES" target="https://www.iana.org/assignments | ||||
/location-type-registry/location-type-registry.xhtml"> | ||||
<front> | ||||
<title>IANA Location Types Registry</title> | ||||
<author /> | ||||
<date /> | ||||
</front> | ||||
</reference> | ||||
<reference anchor="LINKRELS" target="https://www.iana.org/assignments/link | ||||
-relations/link-relations.xhtml"> | ||||
<front> | ||||
<title>IANA Link Relation Types</title> | ||||
<author /> | ||||
<date /> | ||||
</front> | ||||
</reference> | ||||
<reference anchor="MEDIATYPES" target="https://www.iana.org/assignments/me | ||||
dia-types/media-types.xhtml"> | ||||
<front> | ||||
<title>IANA Media Types</title> | ||||
<author /> | ||||
<date /> | ||||
</front> | ||||
</reference> | ||||
</references> | </references> | |||
<section anchor="acknowledgments" numbered="false" toc="default"> | ||||
<name>Acknowledgments</name> | ||||
<t>The authors would like to thank the members of CalConnect for their val | ||||
uable contributions. This specification originated from the work of the API tech | ||||
nical committee of CalConnect: The Calendaring and Scheduling Consortium.</t> | ||||
</section> | ||||
</back> | </back> | |||
</rfc> | </rfc> | |||
End of changes. 150 change blocks. | ||||
3596 lines changed or deleted | 4328 lines changed or added | |||
This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/ |