1.4.1.Id

WhereId is given as a data type, it means aString of at least 1 and a maximum of 255 octets in size, and itMUST only contain characters from the "URL and Filename Safe" base64url alphabet, as defined inSection 5 of [RFC4648], excluding the pad character (=). This means the allowed characters are the ASCII alphanumeric characters (A-Za-z0-9), hyphen (-), and underscore (_).¶

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 construction represents an unordered set of objects, with the added advantage that each entry has a name (the corresponding map key). This allows for more concise patching of objects, and, when applicable, for the objects in question to be referenced from other objects within the JSCalendar object.¶

Unless otherwise specified for a particular property, there are no uniqueness constraints on an Id value (other than, of course, the requirement that you cannot have two values with the same key within a single JSON map). For example, two Event objects might use the same Ids in their respectivelinks properties or, within the same Event object, the same Id could appear in theparticipants andalerts properties. These situations do not imply any semantic connections among the objects.¶

1.4.2.Int

WhereInt is given as a data type, it means an integer in the range -2⁵³+1 <= value <= 2⁵³-1, the safe range for integers stored in a floating-point double, represented as a JSONNumber.¶

1.4.3.UnsignedInt

WhereUnsignedInt is given as a data type, it means an integer in the range 0 <= value <= 2⁵³-1, represented as a JSONNumber.¶

1.4.4.UTCDateTime

This is a string in thedate-time[RFC3339] format, with the further restrictions that any lettersMUST be in uppercase, and the time offsetMUST be the characterZ. Fractional second valuesMUST NOT be included unless non-zero andMUST NOT have trailing zeros, to ensure there is only a single representation for each date-time.¶

For example,2010-10-10T10:10:10.003Z is conformant, but2010-10-10T10:10:10.000Z is invalid and is correctly encoded as2010-10-10T10:10:10Z.¶

1.4.5.LocalDateTime

This is a date-time string with no time zone/offset information. It is otherwise in the same format as UTCDateTime, including fractional seconds. For example,2006-01-02T15:04:05 and2006-01-02T15:04:05.003 are both valid. The time zone to associate with the LocalDateTime comes from thetimeZone property of the JSCalendar object (seeSection 4.7.1). If no time zone is specified, the LocalDateTime isfloating. Floating date-times are not tied to any specific time zone. Instead, they occur in each time zone at the given wall-clock time (as opposed to the same instant point in time).¶

A time zone may have a period of discontinuity, for example, a change from standard time to daylight savings time. When converting local date-times that fall in the discontinuity to UTC, the offset before the transitionMUST be used.¶

For example, in the America/Los_Angeles time zone, the date-time 2020-11-01T01:30:00 occurs twice: before the daylight savings time (DST) transition with a UTC offset of -07:00 and again after the transition with an offset of -08:00. When converting to UTC, we therefore use the offset before the transition (-07:00), so it becomes 2020-11-01T08:30:00Z.¶

Similarly, in the Australia/Melbourne time zone, the date-time 2020-10-04T02:30:00 does not exist; the clocks are moved forward one hour for DST on that day at 02:00. However, such a value may appear during calculations (see duration semantics inSection 1.4.6) or due to a change in time zone rules (so it was valid when the event was first created). Again, it is interpreted as though the offset before the transition is in effect (+10:00); therefore, when converted to UTC, we get 2020-10-03T16:30:00Z.¶

1.4.6.Duration

Where Duration is given as a type, it means a length of time represented by a subset of the ISO 8601 duration format, as specified by the following ABNF[RFC5234]:¶

    dur-secfrac = "." 1*DIGIT    dur-second  = 1*DIGIT [dur-secfrac] "S"    dur-minute  = 1*DIGIT "M" [dur-second]    dur-hour    = 1*DIGIT "H" [dur-minute]    dur-time    = "T" (dur-hour / dur-minute / dur-second)    dur-day     = 1*DIGIT "D"    dur-week    = 1*DIGIT "W"    dur-cal     = (dur-week [dur-day] / dur-day)    duration    = "P" (dur-cal [dur-time] / dur-time)

In addition, the durationMUST NOT include fractional second values unless the fraction is non-zero. Fractional second valuesMUST NOT have trailing zeros to ensure there is only a single representation for each duration.¶

A duration specifies an abstract number of weeks, days, hours, minutes, and/or seconds. A duration specified using weeks or days does not always correspond to an exact multiple of 24 hours. The number of hours/minutes/seconds may vary if it overlaps a period of discontinuity in the event's time zone, for example, a change from standard time to daylight savings time. Leap secondsMUST NOT be considered when adding or subtracting a duration to/from a LocalDateTime.¶

To add a duration to a LocalDateTime:¶

1. Add any week or day components of the duration to the date. A week is always the same as seven days.¶
2. If a time zone applies to the LocalDateTime, convert it to a UTCDateTime following the semantics inSection 1.4.5.¶
3. Add any hour, minute, or second components of the duration (in absolute time).¶
4. Convert the resulting UTCDateTime back to a LocalDateTime in the time zone that applies.¶

To subtract a duration from a LocalDateTime, the steps apply in reverse:¶

1. If a time zone applies to the LocalDateTime, convert it to UTC following the semantics inSection 1.4.5.¶
2. Subtract any hour, minute, or second components of the duration (in absolute time).¶
3. Convert the resulting UTCDateTime back to LocalDateTime in the time zone that applies.¶
4. Subtract any week or day components of the duration from the date.¶
5. If the resulting time does not exist on the date due to a discontinuity in the time zone, use the semantics inSection 1.4.5 to convert to UTC and back to get a valid LocalDateTime.¶

These semantics match the iCalendar DURATION value type ([RFC5545],Section 3.3.6).¶

1.4.7.SignedDuration

A SignedDuration represents a length of time that may be positive or negative and is typically used to express the offset of a point in time relative to an associated time. It is represented as a Duration, optionally preceded by a sign character. It is specified by the following ABNF:¶

signed-duration = ["+" / "-"] duration

A negative sign indicates a point in time at or before the associated time; a positive or no sign indicates a time at or after the associated time.¶

1.4.8.TimeZoneId

WhereTimeZoneId is given as a data type, it means aString that is either a time zone name in the IANA Time Zone Database[TZDB] or a custom time zone identifier defined in thetimeZones property (seeSection 4.7.2).¶

Where an IANA time zone is specified, the zone rules of the respective zone records apply. Custom time zones are interpreted as described inSection 4.7.2.¶

1.4.9.PatchObject

A PatchObject is of typeString[*] and represents an unordered set of patches on a JSON object. Each key is a path represented in a subset of the JSON Pointer format[RFC6901]. The paths have an implicit leading/, so each key is prefixed with/ before applying the JSON Pointer evaluation algorithm.¶

A patch within a PatchObject is only valid if all of the following conditions apply:¶

1. The pointerMUST NOT reference inside an array (i.e., youMUST NOT insert/delete from an array; the arrayMUST be replaced in its entirety instead).¶
2. All parts prior to the last (i.e., the value after the final slash)MUST already exist on the object being patched.¶
3. ThereMUST NOT be two patches in the PatchObject where the pointer of one is the prefix of the pointer of the other, e.g.,alerts/1/offset andalerts.¶
4. The value for the patchMUST be valid for the property being set (of the correct type and obeying any other applicable restrictions), or, if null, the propertyMUST be optional.¶

The value associated with each pointer determines how to apply that patch:¶

• If null, remove the property from the patched object. If the key is not present in the parent, this a no-op.¶
• If non-null, set the value given as the value for this property (this may be a replacement or addition to the object being patched).¶

A PatchObject does not define its own@type property (seeSection 4.1.1). An@type property in a patchMUST be handled as any other patched property value.¶

ImplementationsMUST reject a PatchObject in its entirety if any of its patches are invalid. ImplementationsMUST NOT apply partial patches.¶

The PatchObject format is used to significantly reduce file size and duplicated content when specifying variations to a common object, such as with recurring events or when translating the data into multiple languages. It can also better preserve semantic intent if only the properties that should differ between the two objects are patched. For example, if one person is not going to a particular instance of a regularly scheduled event, in iCalendar, 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 changed, the occurrence will automatically still inherit this.¶

1.4.10.Relation

A Relation object defines the relation to other objects, using a possibly empty set of relation types. The object that defines this relation is the linking object, while the other object is the linked object. A Relation object has the following properties:¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beRelation.¶

relation:String[Boolean] (optional, default: empty Object)

This describes how the linked object is related to the linking object. The relation is defined as a set of relation types. If empty, the relationship between the two objects is unspecified.¶

Keys in the setMUST be one of the following values, specified in the property definition where the Relation object is used, a value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3):¶

first:

The linked object is the first in a series the linking object is part of.¶

next:

The linked object is next in a series the linking object is part of.¶

child:

The linked object is a subpart of the linking object.¶

parent:

The linking object is a subpart of the linked object.¶

The value for each key in the mapMUST be true.¶

1.4.11.Link

A Link object represents an external resource associated with the linking object. It has the following properties:¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beLink.¶

href:String (mandatory)

This is a URI[RFC3986] from which the resource may be fetched.¶

ThisMAY be adata: URL[RFC2397], but it is recommended that the file be hosted on a server to avoid embedding arbitrarily large data in JSCalendar object instances.¶

cid:String (optional)

ThisMUST be a validcontent-id value according to the definition ofSection 2 of [RFC2392]. The valueMUST be unique within this Link object but has no meaning beyond that. ItMAY be different from the link id for this Link object.¶

contentType:String (optional)

This is the media type[RFC6838] of the resource, if known.¶

size:UnsignedInt (optional)

This is the size, in octets, of the resource when fully decoded (i.e., the number of octets in the file the user would download), if known. Note that this is an informational estimate, and implementations must be prepared to handle the actual size being quite different when the resource is fetched.¶

rel:String (optional)

This identifies the relation of the linked resource to the object. If set, the valueMUST be a relation type from the IANA "Link Relations" registry[LINKRELS], as established in[RFC8288].¶

display:String (optional)

This describes the intended purpose of a link to an image. If set, therel propertyMUST be set toicon. The valueMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3):¶

badge:

an image meant to be displayed alongside the title of the object¶

graphic:

a full image replacement for the object itself¶

fullsize:

an image that is used to enhance the object¶

thumbnail:

a smaller variant offullsize to be used when space for the image is constrained¶

title:String (optional)

This is a human-readable, plain-text description of the resource.¶

4.1.1.@type

Type:String (mandatory)¶

This specifies the type that this object represents. The allowed value differs by object type and is defined in Sections2.1,2.2, and2.3.¶

4.1.2.uid

Type:String (mandatory)¶

This is a globally unique identifier used to associate objects representing the same event, task, group, or other object across different systems, calendars, and views. For recurring events and tasks, the UID is associated with the base object and therefore is the same for all occurrences; the combination of the UID with arecurrenceId identifies a particular instance.¶

The generator of the identifierMUST guarantee that the identifier is unique.[RFC4122] describes a range of established algorithms to generate universally unique identifiers (UUIDs). UUID version 4, described inSection 4.4 of [RFC4122], isRECOMMENDED.¶

For compatibility with UIDs[RFC5545], implementationsMUST be able to receive and persist values of at least 255 octets for this property, but theyMUST NOT truncate values in the middle of a UTF-8 multi-octet sequence.¶

4.1.3.relatedTo

Type:String[Relation] (optional)¶

This relates the object to other JSCalendar objects. This is represented as a map of the UIDs of the related objects to information about the relation.¶

If an object is split to make a "this and future" change to a recurrence, the original objectMUST be truncated to end at the previous occurrence before this split, and a new object is created to represent all the occurrences after the split. Anext relationMUST be set on the original object'srelatedTo property for the UID of the new object. Afirst relation for the UID of the first object in the seriesMUST be set on the new object. Clients can then follow these UIDs to get the complete set of objects if the user wishes to modify them all at once.¶

4.1.4.prodId

Type:String (optional)¶

This is the identifier for the product that last updated the JSCalendar object. This should be set whenever the data in the object is modified (i.e., whenever theupdated property is set).¶

The vendor of the implementationMUST ensure that this is a globally unique identifier, using some technique such as a Formal Public Identifier (FPI) value, as defined in[ISO.9070.1991].¶

This propertySHOULD NOT be used to alter the interpretation 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 properties, a practice that is known to cause long-term interoperability problems.¶

4.1.5.created

Type:UTCDateTime (optional)¶

This is the date and time this object was initially created.¶

4.1.6.updated

Type:UTCDateTime (mandatory)¶

This is the date and time the data in this object was last modified (or its creation date/time if not modified since).¶

4.1.7.sequence

Type:UnsignedInt (optional, default: 0)¶

Initially zero, thisMUST be incremented by one every time a change is made to the object, except if the change only modifies theparticipants property (seeSection 4.4.6).¶

This is used as part of the iCalendar Transport-independent Interoperability Protocol (iTIP)[RFC5546] to know which version of the object a scheduling message relates to.¶

4.1.8.method

Type:String (optional)¶

This is the iTIP[RFC5546] method, in lowercase. ThisMUST only be present if the JSCalendar object represents an iTIP scheduling message.¶

4.2.1.title

Type:String (optional, default: empty String)¶

This is a short summary of the object.¶

4.2.2.description

Type:String (optional, default: empty String)¶

This is a longer-form text description of the object. The content is formatted according to thedescriptionContentType property.¶

4.2.3.descriptionContentType

Type:String (optional, default:text/plain)¶

This describes the media type[RFC6838] of the contents of thedescription property. Media typesMUST be subtypes of typetext andSHOULD betext/plain ortext/html[MEDIATYPES]. TheyMAY include parameters, and thecharset parameter valueMUST beutf-8, if specified. Descriptions of typetext/htmlMAY containcid URLs[RFC2392] to reference links in the calendar object by use of thecid property of the Link object.¶

4.2.4.showWithoutTime

Type:Boolean (optional, default: false)¶

This indicates that the time is not important to display to the user when rendering this calendar object. An example of this is an event that conceptually occurs all day or across multiple days, such as "New Year's Day" or "Italy Vacation". While the time component is important for free-busy calculations and checking for scheduling clashes, calendars may choose to omit displaying it and/or display the object separately to other objects to enhance the user's view of their schedule.¶

Such events are also commonly known as "all-day" events.¶

4.2.5.locations

Type:Id[Location] (optional)¶

This is a map of location ids to Location objects, representing locations associated with the object.¶

A Location object has the following properties. ItMUST have at least one property other than therelativeTo property.¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beLocation.¶

name:String (optional)

This is the human-readable name of the location.¶

description:String (optional)

This is the human-readable, plain-text instructions for accessing this location. This may be an address, set of directions, door access code, etc.¶

locationTypes:String[Boolean] (optional)

This is a set of one or more location types that describe this location. All typesMUST be from the "Location Types Registry"[LOCATIONTYPES], as defined in[RFC4589]. The set is represented as a map, with the keys being the location types. The value for each key in the mapMUST be true.¶

relativeTo:String (optional)

This specifies the relation between this location and the time of the JSCalendar object. This is primarily to allow events representing travel to specify the location of departure (at the start of the event) and location of arrival (at the end); this is particularly important if these locations are in different time zones, as a client may wish to highlight this information for the user.¶

ThisMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3). Any value the client or server doesn't understand should be treated the same as if this property is omitted.¶

start:

The event/task described by this JSCalendar object occurs at this location at the time the event/task starts.¶

end:

The event/task described by this JSCalendar object occurs at this location at the time the event/task ends.¶

timeZone:TimeZoneId (optional)

This is a time zone for this location.¶

coordinates:String (optional)

This is ageo: URI[RFC5870] for the location.¶

links:Id[Link] (optional)

This is a map of link ids to Link objects, representing external resources associated with this location, for example, a vCard or image. If there are no links, thisMUST be omitted (rather than specified as an empty set).¶

4.2.6.virtualLocations

Type:Id[VirtualLocation] (optional)¶

This is a map of virtual location ids to VirtualLocation objects, representing virtual locations, such as video conferences or chat rooms, associated with the object.¶

A VirtualLocation object has the following properties.¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beVirtualLocation.¶

name:String (optional, default: empty String)

This is the human-readable name of the virtual location.¶

description:String (optional)

These are human-readable plain-text instructions for accessing this virtual location. This may be a conference access code, etc.¶

uri:String (mandatory)

This is a URI[RFC3986] that represents how to connect to this virtual location.¶

This may be a telephone number (represented using thetel: scheme, e.g.,tel:+1-555-555-5555) for a teleconference, a web address for online chat, or any custom URI.¶

features:String[Boolean] (optional)

A set of features supported by this virtual location. The set is represented as a map, with the keys being the feature. The value for each key in the mapMUST be true.¶

The featureMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3). Any value the client or server doesn't understand should be treated the same as if this feature is omitted.¶

audio:

Audio conferencing¶

chat:

Chat or instant messaging¶

feed:

Blog or atom feed¶

moderator:

Provides moderator-specific features¶

phone:

Phone conferencing¶

screen:

Screen sharing¶

video:

Video conferencing¶

4.2.7.links

Type:Id[Link] (optional)¶

This is a map of link ids to Link objects, representing external resources associated with the object.¶

Links with a rel ofenclosureMUST be considered by the client to be attachments for download.¶

Links with a rel ofdescribedbyMUST be considered by the client to be alternative representations of the description.¶

Links with a rel oficonMUST be considered by the client to be images that it may use when presenting the calendar data to a user. Thedisplay property may be set to indicate the purpose of this image.¶

4.2.8.locale

Type:String (optional)¶

This is the language tag, as defined in[RFC5646], that best describes the locale used for the text in the calendar object, if known.¶

4.2.9.keywords

Type:String[Boolean] (optional)¶

This is a set of keywords or tags that relate to the object. The set is represented as a map, with the keys being the keywords. The value for each key in the mapMUST be true.¶

4.2.10.categories

Type:String[Boolean] (optional)¶

This is a set of categories that relate to the calendar object. The set is represented as a map, with the keys being the categories specified as URIs. The value for each key in the mapMUST be true.¶

In contrast to keywords, categories are typically structured. For example, a vendor owning the domainexample.com might define the categorieshttp://example.com/categories/sports/american-football andhttp://example.com/categories/music/r-b.¶

4.2.11.color

Type:String (optional)¶

This is a color clientsMAY use when displaying this calendar object. The value is a color name taken from the set of names defined in Section 4.3 of CSS Color Module Level 3[COLORS] or an RGB value in hexadecimal notation, as defined in Section 4.2.1 of CSS Color Module Level 3.¶

4.3.1.recurrenceId

Type:LocalDateTime (optional)¶

If present, this JSCalendar object represents one occurrence of a recurring JSCalendar object. If present, therecurrenceRules andrecurrenceOverrides propertiesMUST NOT be present.¶

The value is a date-time either produced by therecurrenceRules of the base event or added as a key to therecurrenceOverrides property of the base event.¶

4.3.2.recurrenceIdTimeZone

Type:TimeZoneId|null (optional, default: null)¶

Identifies the time zone of the main JSCalendar object, of which this JSCalendar object is a recurrence instance. This propertyMUST be set if therecurrenceId property is set. ItMUST NOT be set if therecurrenceId property is not set.¶

4.3.3.recurrenceRules

Type:RecurrenceRule[] (optional)¶

This defines a set of recurrence rules (repeating patterns) for recurring calendar objects.¶

An Event recurs by applying the recurrence rules to thestart date-time.¶

A Task recurs by applying the recurrence rules to thestart date-time, if defined; otherwise, it recurs by thedue date-time, if defined. If the task defines neither astart nordue date-time, itMUST NOT define arecurrenceRules property.¶

If multiple recurrence rules are given, each rule is to be applied, and then the union of the results are used, ignoring any duplicates.¶

A RecurrenceRule object is a JSON object mapping of a RECUR value type in iCalendar[RFC5545][RFC7529] and has the same semantics. It has the following properties:¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beRecurrenceRule.¶

frequency:String (mandatory)

This is the time span covered by each iteration of this recurrence rule (seeSection 4.3.3.1 for full semantics). ThisMUST be one of the following values:¶

• yearly¶
• monthly¶
• weekly¶
• daily¶
• hourly¶
• minutely¶
• secondly¶

This is the FREQ part from iCalendar, converted to lowercase.¶

interval:UnsignedInt (optional, default: 1)

This is the interval of iteration periods at which the recurrence repeats. If included, itMUST be an integer >= 1.¶

This is the INTERVAL part from iCalendar.¶

rscale:String (optional, default: "gregorian")

This is the calendar system in which this recurrence rule operates, in lowercase. ThisMUST be either a CLDR-registered calendar system name[CLDR] or a vendor-specific value (seeSection 3.3).¶

This is the RSCALE part from iCalendarRSCALE [RFC7529], converted to lowercase.¶

skip:String (optional, default: "omit")

This is the behavior to use when the expansion of the recurrence produces invalid dates. This property only has an effect if the frequency is "yearly" or "monthly". ItMUST be one of the following values:¶

• omit¶
• backward¶
• forward¶

This is the SKIP part from iCalendarRSCALE [RFC7529], converted to lowercase.¶

firstDayOfWeek:String (optional, default: "mo")

This is the day on which the week is considered to start, represented as a lowercase, abbreviated, and two-letter English day of the week. If included, itMUST be one of the following values:¶

• mo¶
• tu¶
• we¶
• th¶
• fr¶
• sa¶
• su¶

This is the WKST part from iCalendar.¶

byDay:NDay[] (optional)

These are days of the week on which to repeat. AnNDay object has the following properties:¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beNDay.¶

day:String (mandatory)

This is a day of the week on which to repeat; the allowed values are the same as for thefirstDayOfWeek recurrenceRule property.¶

This is the day of the week of the BYDAY part in iCalendar, converted to lowercase.¶

nthOfPeriod:Int (optional)

If present, rather than representing every occurrence of the weekday defined in theday property, it represents only a specific instance within the recurrence period. The value can be positive or negative butMUST NOT be zero. A negative integer means the nth-last occurrence within that period (i.e., -1 is the last occurrence, -2 the one before that, etc.).¶

This is the ordinal part of the BYDAY value in iCalendar (e.g., 1 or -3).¶

byMonthDay:Int[] (optional)

These are the 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 therscale property and the negative values of these numbers. For example, in the Gregorian calendar, valid values are 1 to 31 and -31 to -1. Negative values offset from the end of the month. The arrayMUST have at least one entry if included.¶

This is the BYMONTHDAY part in iCalendar.¶

byMonth:String[] (optional)

These are 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" means January with the Gregorian calendar), with an optional "L" suffix (see[RFC7529]) for leap months (thisMUST be uppercase, e.g., "3L"). The arrayMUST have at least one entry if included.¶

This is the BYMONTH part from iCalendar.¶

byYearDay:Int[] (optional)

These are 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 therscale property and the negative values of these numbers. For example, in the Gregorian calendar, valid values are 1 to 366 and -366 to -1. Negative values offset from the end of the year. The arrayMUST have at least one entry if included.¶

This is the BYYEARDAY part from iCalendar.¶

byWeekNo:Int[] (optional)

These are the 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 therscale property and the negative values of these numbers. For example, in the Gregorian calendar, valid values are 1 to 53 and -53 to -1. The arrayMUST have at least one entry if included.¶

This is the BYWEEKNO part from iCalendar.¶

byHour:UnsignedInt[] (optional)

These are the hours of the day in which to repeat. Valid values are 0 to 23. The arrayMUST have at least one entry if included. This is the BYHOUR part from iCalendar.¶

byMinute:UnsignedInt[] (optional)

These are the minutes of the hour in which to repeat. Valid values are 0 to 59. The arrayMUST have at least one entry if included.¶

This is the BYMINUTE part from iCalendar.¶

bySecond:UnsignedInt[] (optional)

These are the seconds of the minute in which to repeat. Valid values are 0 to 60. The arrayMUST have at least one entry if included.¶

This is the BYSECOND part from iCalendar.¶

bySetPosition:Int[] (optional)

These are the occurrences within the recurrence interval to include in the final results. Negative values offset from the end of the list of occurrences. The arrayMUST have at least one entry if included. This is the BYSETPOS part from iCalendar.¶

count:UnsignedInt (optional)

These are the number of occurrences at which to range-bound the recurrence. ThisMUST NOT be included if anuntil property is specified.¶

This is the COUNT part from iCalendar.¶

until:LocalDateTime (optional)

These are the date-time at which to finish recurring. The last occurrence is on or before this date-time. ThisMUST NOT be included if acount property is specified. Note that if not specified otherwise for a specific JSCalendar object, this date is to be interpreted in the time zone specified in the JSCalendar object'stimeZone property.¶

This is the UNTIL part from iCalendar.¶

4.3.4.excludedRecurrenceRules

Type:RecurrenceRule[] (optional)¶

This defines a set of recurrence rules (repeating patterns) for date-times on which the object will not occur. The rules are interpreted the same as for therecurrenceRules property (seeSection 4.3.3), with the exception that the initial date-time to which the rule is applied (the "start" date-time for events or the "start" or "due" date-time for tasks) is only considered part of the expansion if it matches the rule. The resulting set of date-times is then removed from those generated by therecurrenceRules property, as described inSection 4.3.¶

4.3.5.recurrenceOverrides

Type:LocalDateTime[PatchObject] (optional)¶

Maps recurrence ids (the date-time produced by the recurrence rule) to the overridden properties of the recurrence instance.¶

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 case.¶

If the patch object defines theexcluded property of an occurrence to be true, this occurrence is omitted from the final set of recurrences for the calendar object (like an EXDATE from iCalendar). Such a patch objectMUST NOT patch any other property.¶

By default, an occurrence inherits all properties from the main object except the start (or due) date-time, which is shifted to match the recurrence id LocalDateTime. However, individual properties of the occurrence can be modified by a patch or multiple patches. It is valid to patch thestart property value, and this patch takes precedence over the value generated from the recurrence id. Both the recurrence id as well as the patchedstart date-time may occur before the original JSCalendar object'sstart ordue date.¶

A pointer in the PatchObjectMUST be ignored if it starts with one of the following prefixes:¶

• @type¶
• excludedRecurrenceRules¶
• method¶
• privacy¶
• prodId¶
• recurrenceId¶
• recurrenceIdTimeZone¶
• recurrenceOverrides¶
• recurrenceRules¶
• relatedTo¶
• replyTo¶
• sentBy¶
• timeZones¶
• uid¶

4.3.6.excluded

Type:Boolean (optional, default: false)¶

This defines if this object is an overridden, excluded instance of a recurring JSCalendar object (seeSection 4.3.5). If this property value is true, this calendar object instanceMUST be removed from the occurrence expansion. The absence of this property, or the presence of its default value as false, indicates that this instanceMUST be included in the occurrence expansion.¶

4.4.1.priority

Type:Int (optional, default: 0)¶

This specifies a priority for the calendar object. This may be used as part of scheduling systems to help resolve conflicts for a time period.¶

The priority is specified as an integer in the range 0 to 9. A value of 0 specifies an undefined priority, for which the treatment will vary by situation. 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.¶

4.4.2.freeBusyStatus

Type:String (optional, default:busy)¶

This specifies how this calendar object should be treated when calculating free-busy state. ThisMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3):¶

free:

The object should be ignored when calculating whether the user is busy.¶

busy:

The object should be included when calculating whether the user is busy.¶

4.4.3.privacy

Type:String (optional, default:public)¶

Calendar objects are normally collected together and may be shared with other users. The privacy property allows the object owner to indicate that it should not be shared or should only have the time information shared but the details withheld. Enforcement of the restrictions indicated by this property is up to the API via which this object is accessed.¶

This propertyMUST NOT affect the information sent to scheduled participants; it is only interpreted by protocols that share the calendar objects belonging to one user with other users.¶

The valueMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3). Any value the client or server doesn't understand should be preserved but treated as equivalent toprivate.¶

public:

The full details of the object are visible to those whom the object's calendar is shared with.¶

private:

The details of the object are hidden; only the basic time and metadata are shared. The following propertiesMAY be shared; any other propertiesMUST NOT be shared:¶

• @type¶
• created¶
• due¶
• duration¶
• estimatedDuration¶
• freeBusyStatus¶
• privacy¶
• recurrenceOverrides (Only patches that apply to another permissible property are allowed to be shared.)¶
• sequence¶
• showWithoutTime¶
• start¶
• timeZone¶
• timeZones¶
• uid¶
• updated¶

secret:

The object is hidden completely (as though it did not exist) when the calendar this object is in is shared.¶

4.4.4.replyTo

Type:String[String] (optional)¶

This represents methods by which participants may submit their response to the organizer of the calendar object. The keys in the property value are the available methods andMUST only contain ASCII alphanumeric characters (A-Za-z0-9). The value is a URI for the method specified in the key. Future methods may be defined in future specifications and registered with IANA; a calendar clientMUST ignore any method it does not understand butMUST preserve the method key and URI. This propertyMUST be omitted if no method is defined (rather than being specified as an empty object).¶

The following methods are defined:¶

imip:

The organizer accepts an iCalendar Message-Based Interoperability Protocol (iMIP)[RFC6047] response at this email address. The valueMUST be amailto: URI.¶

web:

Opening this URI in a web browser will provide the user with a page where they can submit a reply to the organizer. The valueMUST be a URL using thehttps: scheme.¶

other:

The organizer is identified by this URI, but the method for submitting the response is undefined.¶

4.4.5.sentBy

Type:String (optional)¶

This is the email address in the "From" header of the email in which this calendar object was received. This is only relevant if the calendar object is received via iMIP or as an attachment to a message. If set, the valueMUST be a validaddr-spec value as defined in Section 3.4.1 of[RFC5322].¶

4.4.6.participants

Type:Id[Participant] (optional)¶

This is a map of participant ids to participants, describing their participation in the calendar object.¶

If this property is set and any participant has asendTo property, then thereplyTo property of this calendar objectMUST define at least one reply method.¶

A Participant object has the following properties:¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beParticipant.¶

name:String (optional)

This is the display name of the participant (e.g., "Joe Bloggs").¶

email:String (optional)

This is the email address to use to contact the participant or, for example, match with an address book entry. If set, the valueMUST be a validaddr-spec value as defined in Section 3.4.1 of[RFC5322].¶

description:String (optional)

This is a plain-text description of this participant. For example, this may include more information about their role in the event or how best to contact them.¶

sendTo:String[String] (optional)

This represents methods by which the participant may receive the invitation and updates to the calendar object.¶

The keys in the property value are the available methods andMUST only contain ASCII alphanumeric characters (A-Za-z0-9). The value is a URI for the method specified in the key. Future methods may be defined in future specifications and registered with IANA; a calendar clientMUST ignore any method it does not understand butMUST preserve the method key and URI. This propertyMUST be omitted if no method is defined (rather than being specified as an empty object).¶

The following methods are defined:¶

imip:

The participant accepts an iMIP[RFC6047] request at this email address. The valueMUST be amailto: URI. ItMAY be different from the value of the participant'semail property.¶

other:

The participant is identified by this URI, but the method for submitting the invitation is undefined.¶

kind:String (optional)

This is what kind of entity this participant is, if known.¶

ThisMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3). Any value the client or server doesn't understand should be treated the same as if this property is omitted.¶

individual:

a single person¶

group:

a collection of people invited as a whole¶

location:

a physical location that needs to be scheduled, e.g., a conference room¶

resource:

a non-human resource other than a location, such as a projector¶

roles:String[Boolean] (mandatory)

This is a set of roles that this participant fulfills.¶

At least one roleMUST be specified for the participant. The keys in the setMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3):¶

owner:

The participant is an owner of the object. This signifies they have permission to make changes to it that affect the other participants. Nonowner participants may only change properties that affect only themselves (for example, setting their own alerts or changing their RSVP status).¶

attendee:

The participant is expected to be present at the event.¶

optional:

The participant's involvement with the event is optional. This is expected to be primarily combined with the "attendee" role.¶

informational:

The participant is copied for informational reasons and is not expected to attend.¶

chair:

The participant is in charge of the event/task when it occurs.¶

contact:

The participant is someone that may be contacted for information about the event.¶

The value for each key in the mapMUST be true. It is expected that no more than one of the roles "attendee" and "informational" be present; if more than one are given, "attendee" takes precedence over "informational". Roles that are unknown to the implementationMUST be preserved.¶

locationId:Id (optional)

This is the location at which this participant is expected to be attending.¶

If the value does not correspond to any location id in thelocations property of the JSCalendar object, thisMUST be treated the same as if the participant's locationId were omitted.¶

language:String (optional)

This is the language tag, as defined in[RFC5646], that best describes the participant's preferred language, if known.¶

participationStatus:String (optional, default:needs-action)

This is the participation status, if any, of this participant.¶

The valueMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3):¶

needs-action:

No status has yet been set by the participant.¶

accepted:

The invited participant will participate.¶

declined:

The invited participant will not participate.¶

tentative:

The invited participant may participate.¶

delegated:

The invited participant has delegated their attendance to another participant, as specified in thedelegatedTo property.¶

participationComment:String (optional)

This is a note from the participant to explain their participation status.¶

expectReply:Boolean (optional, default: false)

If true, the organizer is expecting the participant to notify them of their participation status.¶

scheduleAgent:String (optional, default:server)

This is who is responsible for sending scheduling messages with this calendar object to the participant.¶

The valueMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3):¶

server:

The calendar server will send the scheduling messages.¶

client:

The calendar client will send the scheduling messages.¶

none:

No scheduling messages are to be sent to this participant.¶

scheduleForceSend:Boolean (optional, default: false)

A client may set the property on a participant to true to request that the server send a scheduling message to the participant when it would not normally do so (e.g., if no significant change is made the object or the scheduleAgent is set to client). The propertyMUST NOT be stored in the JSCalendar object on the server or appear in a scheduling message.¶

scheduleSequence:UnsignedInt (optional, default: 0)

This is the sequence number of the last response from the participant. If defined, thisMUST be a nonnegative integer.¶

This can be used to determine whether the participant has sent a new response following significant changes to the calendar object and to determine if future responses are responding to a current or older view of the data.¶

scheduleStatus:String[] (optional)

This is a list of status codes, returned from the processing of the most recent scheduling message sent to this participant. The status codes MUST be validstatcode values as defined in the ABNF inSection 3.8.8.3 of [RFC5545].¶

ServersMUST only add or change this property when they send a scheduling message to the participant. ClientsSHOULD NOT change or remove this property if it was provided by the server. ClientsMAY add, change, or remove the property for participants where the client is handling the scheduling.¶

This propertyMUST NOT be included in scheduling messages.¶

scheduleUpdated:UTCDateTime (optional)

This is the timestamp for the most recent response from this participant.¶

This is theupdated property of the last response when using iTIP. It can be compared to theupdated property in future responses to detect and discard older responses delivered out of order.¶

sentBy:String (optional)

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 email address is different to that in the mailto URI of this participant'simip method in thesendTo property (i.e., the response was received from a different address to that which the invitation was sent to). If set, the valueMUST be a validaddr-spec value as defined in Section 3.4.1 of[RFC5322].¶

invitedBy:Id (optional)

This is the id of the participant who added this participant to the event/task, if known.¶

delegatedTo:Id[Boolean] (optional)

This is set of participant ids that this participant has delegated their participation to. Each key in the setMUST be the id of a participant. The value for each key in the mapMUST be true. If there are no delegates, thisMUST be omitted (rather than specified as an empty set).¶

delegatedFrom:Id[Boolean] (optional)

This is a set of participant ids that this participant is acting as a delegate for. Each key in the setMUST be the id of a participant. The value for each key in the mapMUST be true. If there are no delegators, thisMUST be omitted (rather than specified as an empty set).¶

memberOf:Id[Boolean] (optional)

This is a set of group participants that were invited to this calendar object, which caused this participant to be invited due to their membership in the group(s). Each key in the setMUST be the id of a participant. The value for each key in the mapMUST be true. If there are no groups, thisMUST be omitted (rather than specified as an empty set).¶

links:Id[Link] (optional)

This is a map of link ids to Link objects, representing external resources associated with this participant, for example, a vCard or image. If there are no links, thisMUST be omitted (rather than specified as an empty set).¶

progress:String (optional; only allowed for participants of a Task)

This represents the progress of the participant for this task. ItMUST NOT be set if theparticipationStatus of this participant is any value other thanaccepted. SeeSection 5.2.5 for allowed values and semantics.¶

progressUpdated:UTCDateTime (optional; only allowed for participants of a Task)

This specifies the date-time theprogress property was last set on this participant. SeeSection 5.2.6 for allowed values and semantics.¶

percentComplete:UnsignedInt (optional; only allowed for participants of a Task)

This represents the percent completion of the participant for this task. The property valueMUST be a positive integer between 0 and 100.¶

4.4.7.requestStatus

Type:String (optional)¶

A request status as returned from processing the most recent scheduling request for this JSCalendar object. The allowed values are defined by the ABNF definitions ofstatcode,statdesc andextdata inSection 3.8.8.3 of [RFC5545] and the following ABNF[RFC5234]:¶

reqstatus = statcode ";" statdesc [";" extdata]

ServersMUST only add or change this property when they performe a scheduling action. ClientsSHOULD NOT change or remove this property if it was provided by the server. ClientsMAY add, change, or remove the property when the client is handling the scheduling.¶

This propertyMUST only be included in scheduling messages according to the rules defined for the REQUEST-STATUS iCalendar property in[RFC5546].¶

4.5.1.useDefaultAlerts

Type:Boolean (optional, default: false)¶

If true, use the user's default alerts and ignore the value of thealerts property. Fetching user defaults is dependent on the API from which this JSCalendar object is being fetched and is not defined in this specification. If an implementation cannot determine the user's default alerts, or none are set, itMUST process thealerts property as ifuseDefaultAlerts is set to false.¶

4.5.2.alerts

Type:Id[Alert] (optional)¶

This is a map of alert ids to Alert objects, representing alerts/reminders to display or send to the user for this calendar object.¶

An Alert object has the following properties:¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beAlert.¶

trigger:OffsetTrigger|AbsoluteTrigger|UnknownTrigger (mandatory)

This defines when to trigger the alert. New types may be defined in future documents.¶

AnOffsetTrigger object has the following properties:¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beOffsetTrigger.¶

offset:SignedDuration (mandatory)

This defines the offset at which to trigger the alert relative to the time property defined in therelativeTo property of the alert. Negative durations signify alerts before the time property; positive durations signify alerts after the time property.¶

relativeTo:String (optional, default:start)

This specifies the time property that the alert offset is relative to. The valueMUST be one of the following:¶

start:

triggers the alert relative to the start of the calendar object¶

end:

triggers the alert relative to the end/due time of the calendar object¶

AnAbsoluteTrigger object has the following properties:¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beAbsoluteTrigger.¶

when:UTCDateTime (mandatory)

This defines a specific UTC date-time when the alert is triggered.¶

AnUnknownTrigger object is an object that contains an@type property whose value is not recognized (i.e., notOffsetTrigger orAbsoluteTrigger) plus zero or more other properties. This is for compatibility with client extensions and future specifications. ImplementationsSHOULD NOT trigger for trigger types they do not understand butMUST preserve them.¶

acknowledged:UTCDateTime (optional)

This records when an alert was last acknowledged. This is set when the user has dismissed the alert; other clients that sync this propertySHOULD automatically dismiss or suppress duplicate alerts (alerts with the same alert id that triggered on or before this date-time).¶

For a recurring calendar object, setting theacknowledged propertyMUST NOT add a new override to therecurrenceOverrides property. If the alert is not already overridden, theacknowledged propertyMUST be set on the alert in the base event/task.¶

Certain kinds of alert action may not provide feedback as to when the user sees them, for example, email-based alerts. For those kinds of alerts, this propertyMUST be set immediately when the alert is triggered and the action is successfully carried out.¶

relatedTo:String[Relation] (optional)

This relates this alert to other alerts in the same JSCalendar object. If the user wishes to snooze an alert, the applicationMUST create an alert to trigger after snoozing. This new snooze alertMUST set a parent relation to the identifier of the original alert.¶

action:String (optional, default:display)

This describes how to alert the user.¶

The valueMUST be at most one of the following values, a value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3):¶

display:

The alert should be displayed as appropriate for the current device and user context.¶

email:

The alert should trigger an email sent out to the user, notifying them of the alert. This action is typically only appropriate for server implementations.¶

4.6.1.localizations

Type:String[PatchObject] (optional)¶

A map where each key is a language tag[RFC5646], and the corresponding value is a set of patches to apply to the calendar object in order to localize it into that locale.¶

See the description ofPatchObject (Section 1.4.9) for the structure of the PatchObject. The patches are applied to the top-level calendar object. In addition, thelocale property of the patched object is set to the language tag. All pointers for patchesMUST end with one of the following suffixes; any patch that does not follow thisMUST be ignored unless otherwise specified in a future RFC:¶

• title¶
• description¶
• name¶

A patchMUST NOT have the prefixrecurrenceOverrides; any localization of the overrideMUST be a patch to thelocalizations property inside the override instead. For example, a patch tolocations/abcd1234/title is permissible, but a patch touid orrecurrenceOverrides/2020-01-05T14:00:00/title is not.¶

Note that this specification does not define how to maintain validity of localized content. For example, a client application changing a JSCalendar object'stitle property might also need to update any localizations of this property. Client implementationsSHOULD provide the means to manage localizations, but how to achieve this is specific to the application's workflow and requirements.¶

4.7.1.timeZone

Type:TimeZoneId|null (optional, default: null)¶

This identifies the time zone the object is scheduled in or is null for floating time. This is either a name from the IANA Time Zone Database[TZDB] or the TimeZoneId of a custom time zone from thetimeZones property (Section 4.7.2). If omitted, thisMUST be presumed to be null (i.e., floating time).¶

4.7.2.timeZones

Type:TimeZoneId[TimeZone] (optional)¶

This maps identifiers of custom time zones to their time zone definitions. The following restrictions apply for each key in the map:¶

• To avoid conflict with names in the IANA Time Zone Database[TZDB], itMUST start with the/ character.¶
• ItMUST be a validparamtext value, as specified inSection 3.1 of [RFC5545].¶
• At least one other property in the same JSCalendar objectMUST reference a time zone using this identifier (i.e., orphaned time zones are not allowed).¶

An identifier need only be unique to this JSCalendar object. ItMAY differ from thetzId property value of the TimeZone object it maps to.¶

A JSCalendar object may be part of a hierarchy of other JSCalendar objects (say, an Event is an entry in a Group). In this case, the set of time zones 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 closest to the calendar object in relation to its parentsMUST be used. (In context of Event, a time zone definition in itstimeZones property has precedence over a definition of the same id in the Group). Time zone definitions in any children of the calendar objectMUST be ignored.¶

A TimeZone object maps a VTIMEZONE component from iCalendar, and the semantics are as defined in[RFC5545]. A valid time zoneMUST define at least one transition rule in thestandard ordaylight property. Its properties are:¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beTimeZone.¶

tzId:String (mandatory)

This is the TZID property from iCalendar. Note that this implies that the valueMUST be a validparamtext value as specified in Section 3.1. of[RFC5545].¶

updated:UTCDateTime (optional)

This is the LAST-MODIFIED property from iCalendar.¶

url:String (optional)

This is the TZURL property from iCalendar.¶

validUntil:UTCDateTime (optional)

This is the TZUNTIL property from iCalendar, specified in[RFC7808].¶

aliases:String[Boolean] (optional)

This maps the TZID-ALIAS-OF properties from iCalendar, specified in[RFC7808], to a JSON set of aliases. The set is represented as an object, with the keys being the aliases. The value for each key in the mapMUST be true.¶

standard:TimeZoneRule[] (optional)

This the STANDARD sub-components from iCalendar. The orderMUST be preserved during conversion.¶

daylight:TimeZoneRule[] (optional)

This the DAYLIGHT sub-components from iCalendar. The orderMUST be preserved during conversion.¶

A TimeZoneRule object maps a STANDARD or DAYLIGHT sub-component from iCalendar, with the restriction that, at most, one recurrence rule is allowed per rule. It has the following properties:¶

@type:String (mandatory)

This specifies the type of this object. ThisMUST beTimeZoneRule.¶

start:LocalDateTime (mandatory)

This is the DTSTART property from iCalendar.¶

offsetFrom:String (mandatory)

This is the TZOFFSETFROM property from iCalendar.¶

offsetTo:String (mandatory)

This is the TZOFFSETTO property from iCalendar.¶

recurrenceRules:RecurrenceRule[] (optional)

This is the RRULE property mapped, as specified inSection 4.3.3. During recurrence rule evaluation, theuntil property valueMUST be interpreted as a local time in the UTC time zone.¶

recurrenceOverrides:LocalDateTime[PatchObject] (optional)

This maps the RDATE properties from iCalendar. The set is represented as an object, with the keys being the recurrence dates. The patch objectMUST be the empty JSON object ({}).¶

names:String[Boolean] optional)

This maps the TZNAME properties from iCalendar to a JSON set. The set is represented as an object, with the keys being the names, excluding anytznparam component from iCalendar. The value for each key in the mapMUST be true.¶

comments:String[] (optional)

This maps the COMMENT properties from iCalendar. The orderMUST be preserved during conversion.¶

5.1.1.start

Type:LocalDateTime (mandatory)¶

This is the date/time the event starts in the event's time zone (as specified in thetimeZone property, seeSection 4.7.1).¶

5.1.2.duration

Type:Duration (optional, default:PT0S)¶

This is the zero or positive duration of the event in the event's start time zone. The end time of an event can be found by adding the duration to the event's start time.¶

An EventMAY involve start and end locations that are in different time zones (e.g., a transcontinental flight). This can be expressed using therelativeTo andtimeZone properties of the Event's Location objects (seeSection 4.2.5).¶

5.1.3.status

Type:String (optional, default:confirmed)¶

This is the scheduling status (Section 4.4) of an Event. If set, itMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3):¶

confirmed:

indicates the event is definitely happening¶

cancelled:

indicates the event has been cancelled¶

tentative:

indicates the event may happen¶

5.2.1.due

Type:LocalDateTime (optional)¶

This is the date/time the task is due in the task's time zone.¶

5.2.2.start

Type:LocalDateTime (optional)¶

This the date/time the task should start in the task's time zone.¶

5.2.3.estimatedDuration

Type:Duration (optional)¶

This specifies the estimated positive duration of time the task takes to complete.¶

5.2.4.percentComplete

Type:UnsignedInt (optional)¶

This represents the percent completion of the task overall. The property valueMUST be a positive integer between 0 and 100.¶

5.2.5.progress

Type:String (optional)¶

This defines the progress of this task. If omitted, the default progress (Section 4.4) of a Task is defined as follows (in order of evaluation):¶

completed:

if theprogress property value of all participants iscompleted¶

failed:

if at least oneprogress property value of a participant isfailed¶

in-process:

if at least oneprogress property value of a participant isin-process¶

needs-action:

if none of the other criteria match¶

If set, itMUST be one of the following values, another value registered in the IANA "JSCalendar Enum Values" registry, or a vendor-specific value (seeSection 3.3):¶

needs-action:

indicates the task needs action¶

in-process:

indicates the task is in process¶

completed:

indicates the task is completed¶

failed:

indicates the task failed¶

cancelled:

indicates the task was cancelled¶

5.2.6.progressUpdated

Type:UTCDateTime (optional)¶

This specifies the date/time theprogress property of either the task overall (Section 5.2.5) or a specific participant (Section 4.4.6) was last updated.¶

If the task is recurring and has future instances, a client may want to keep track of the last progress update timestamp of a specific task recurrence but leave other instances unchanged. One way to achieve this is by overriding theprogressUpdated property in the taskrecurrenceOverrides property. However, this could produce a long list of timestamps for regularly recurring tasks. An alternative approach is to split the Task into a current, single instance of Task with this instance progress update time and a future recurring instance. See alsoSection 4.1.3 on splitting.¶

5.3.1.entries

Type:(Task|Event)[] (mandatory)¶

This is a collection of group members. ImplementationsMUST ignore entries of unknown type.¶

5.3.2.source

Type:String (optional)¶

This is the source from which updated versions of this group may be retrieved. The valueMUST be a URI.¶

8.2.1.Preliminary Community Review

Notice of a potential new registrationSHOULD be sent to the Calext mailing list <calsify@ietf.org> for review. This mailing list is appropriate to solicit community feedback on a proposed new property.¶

Property registrations must be marked with their intended use: "common", "reserved", or "obsolete".¶

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 specification document, and a review of any interoperability or security considerations. The submitter may submit a revised registration proposal or abandon the registration completely at any time.¶

8.2.2.Submit Request to IANA

Registration requests can be sent to <iana@iana.org>.¶

8.2.3.Designated Expert Review

The primary concern of the designated expert (DE) is preventing name 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 inSection 4.6 of [RFC8126], is available 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 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 obsolete registrations.¶

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 modified so as to become acceptable should be provided.¶

8.2.4.Change Procedures

Once a JSCalendar property has been published by IANA, the change controller 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 request.¶

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 usage" field; such properties will be clearly marked in the IANA registry.¶

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 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.¶

The owner of a JSCalendar property may pass responsibility to another person or agency by informing IANA; this can be done without discussion or review.¶

8.2.5."JSCalendar Properties" Registry Template

Property Name:

This is the name of the property. The property nameMUST NOT already be registered for any of the object types listed in the "Property Context" field of this registration. Other object typesMAY already have registered a different property with the same name; however, the same nameSHOULD only be used when the semantics are analogous.¶

Property Type:

This is the type of this property, using type signatures, as specified inSection 1.3. The property typeMUST be registered in the "JSCalendar Types" registry.¶

Property Context:

This is a comma-separated list of JSCalendar object types this property is allowed on.¶

Reference or Description:

This is a brief description or RFC number and section reference where the property is specified (omitted for "reserved" property names).¶

Intended Usage:

This may be "common", "reserved", or "obsolete".¶

Change Controller:

This is who may request a change to this entry's definition (IETF for RFCs from the IETF stream).¶

8.2.6.Initial Contents for the "JSCalendar Properties" Registry

The following table lists the initial entries of the "JSCalendar Properties" registry. All properties are for common use. All RFC section references are for this document. The change controller for all these properties is "IETF".¶

8.3.1."JSCalendar Types" Registry Template

Type Name:

the name of the type¶

Reference or Description:

a brief description or RFC number and section reference where the Type is specified (may be omitted for "reserved" type names)¶

Intended Use:

common, reserved, or obsolete¶

Change Controller:

who may request a change to this entry's definition (IETF for RFCs from the IETF stream)¶

8.3.2.Initial Contents for the "JSCalendar Types" Registry

The following table lists the initial entries of the JSCalendar Types registry. All properties are for common use. All RFC section references are for this document. The change controller for all these properties is "IETF".¶

8.4.1."JSCalendar Enum Values" Registry Property Template

This template is for adding a subregistry for a new enumerable property to the "JSCalendar Enum" registry.¶

Property Name:

These are the name(s) of the property or properties where these values may be used. ThisMUST be registered in the "JSCalendar Properties" registry.¶

Context:

This is the list of allowed object types where the property or 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.¶

Change Controller:

(IETF for properties defined in RFCs from the IETF stream).¶

Initial Contents:

This is the initial list of defined values for this enum, using the template defined inSection 8.4.2. A subregistry will be created with these values for this property name/context tuple.¶

8.4.2."JSCalendar Enum Values" Registry Value Template

This template is for adding a new enum value to a subregistry in the JSCalendar Enum registry.¶

Enum Value:

the verbatim value of the enum¶

Reference or Description:

a brief description or RFC number and section reference for the semantics of this value¶

8.4.3.Initial Contents for the "JSCalendar Enum Values" Registry

For each subregistry created in this section, all RFC section references are for this document.¶

Property Name:

action¶

Context:

Alert¶

Change Controller:

IETF¶

Initial Contents:

Table 3:JSCalendar Enum Values for action (Context: Alert)

Enum Value	Reference or Description
display	Section 4.5.2
email	Section 4.5.2

¶

Property Name:

display¶

Context:

Link¶

Change Controller:

IETF¶

Initial Contents:

Table 4:JSCalendar Enum Values for display (Context: Link)

Enum Value	Reference or Description
badge	Section 1.4.11
graphic	Section 1.4.11
fullsize	Section 1.4.11
thumbnail	Section 1.4.11

¶

Property Name:

features¶

Context:

VirtualLocation¶

Change Controller:

IETF¶

Initial Contents:

Table 5:JSCalendar Enum Values for features (Context: VirtualLocation)

Enum Value	Reference or Description
audio	Section 4.2.6
chat	Section 4.2.6
feed	Section 4.2.6
moderator	Section 4.2.6
phone	Section 4.2.6
screen	Section 4.2.6
video	Section 4.2.6

¶

Property Name:

freeBusyStatus¶

Context:

Event, Task¶

Change Controller:

IETF¶

Initial Contents:

Table 6:JSCalendar Enum Values for freeBusyStatus (Context: Event, Task)

Enum Value	Reference or Description
free	Section 4.4.2
busy	Section 4.4.2

¶

Property Name:

kind¶

Context:

Participant¶

Change Controller:

IETF¶

Initial Contents:

Table 7:JSCalendar Enum Values for kind (Context: Participant)

Enum Value	Reference or Description
individual	Section 4.4.6
group	Section 4.4.6
resource	Section 4.4.6
location	Section 4.4.6

¶

Property Name:

participationStatus¶

Context:

Participant¶

Change Controller:

IETF¶

Initial Contents:

Table 8:JSCalendar Enum Values for participationStatus (Context: Participant)

Enum Value	Reference or Description
needs-action	Section 4.4.6
accepted	Section 4.4.6
declined	Section 4.4.6
tentative	Section 4.4.6
delegated	Section 4.4.6

¶

Property Name:

privacy¶

Context:

Event, Task¶

Change Controller:

IETF¶

Initial Contents:

Table 9:JSCalendar Enum Values for privacy (Context: Event, Task)

Enum Value	Reference or Description
public	Section 4.4.3
private	Section 4.4.3
secret	Section 4.4.3

¶

Property Name:

progress¶

Context:

Task, Participant¶

Change Controller:

IETF¶

Initial Contents:

Table 10:JSCalendar Enum Values for progress (Context: Task, Participant)

Enum Value	Reference or Description
needs-action	Section 5.2.5
in-process	Section 5.2.5
completed	Section 5.2.5
failed	Section 5.2.5
cancelled	Section 5.2.5

¶

Property Name:

relation¶

Context:

Relation¶

Change Controller:

IETF¶

Initial Contents:

Table 11:JSCalendar Enum Values for relation (Context: Relation)

Enum Value	Reference or Description
first	Section 1.4.10
next	Section 1.4.10
child	Section 1.4.10
parent	Section 1.4.10

¶

Property Name:

relativeTo¶

Context:

OffsetTrigger, Location¶

Change Controller:

IETF¶

Initial Contents:

Table 12:JSCalendar Enum Values for relativeTo (Context: OffsetTrigger, Location)

Enum Value	Reference or Description
start	Section 4.5.2
end	Section 4.5.2

¶

Property Name:

roles¶

Context:

Participant¶

Change Controller:

IETF¶

Initial Contents:

Table 13:JSCalendar Enum Values for roles (Context: Participant)

Enum Value	Reference or Description
owner	Section 4.4.6
attendee	Section 4.4.6
optional	Section 4.4.6
informational	Section 4.4.6
chair	Section 4.4.6
contact	Section 4.4.6

¶

Property Name:

scheduleAgent¶

Context:

Participant¶

Change Controller:

IETF¶

Initial Contents:

Table 14:JSCalendar Enum Values for scheduleAgent (Context: Participant)

Enum Value	Reference or Description
server	Section 4.4.6
client	Section 4.4.6
none	Section 4.4.6

¶

Property Name:

status¶

Context:

Event¶

Change Controller:

IETF¶

Initial Contents:

Table 15:JSCalendar Enum Values for status (Context: Event)

Enum Value	Reference or Description
confirmed	Section 5.1.3
cancelled	Section 5.1.3
tentative	Section 5.1.3

¶