element <rule> (local)

Namespace:	http://schemas.microsoft.com/hs/2001/10/myCalendar
Type:	recurrenceRuleBodyBaseType
Content:	complex, 9 elements
Defined:	locally within recurrenceBaseType complexType in myCalendar.xsd; see XML source

XML Representation Summary

<rule>

Content:

creationDate, firstDayOfWeek, tzid?, isLeapYear?, leapMonthValue?, repeat, windowEnd?, repeatForever?, repeatInstances?

</rule>

Content model elements (9):

creationDate (type xsd:dateTime), firstDayOfWeek (type dayOfWeekEnum), isLeapYear (type xsd:boolean), leapMonthValue (type monthValueEnum), repeat (type repeatRuleType), repeatForever (type xsd:boolean), repeatInstances (type xsd:int), tzid (type tzidEnum), windowEnd (type xsd:dateTime)

Included in content model of elements (1):

recurrence (in event in getCalendarDaysResponse)

XML Source (see within schema source)

<xsd:element name="rule" type="recurrenceRuleBodyBaseType"/>

Content Element Detail (all declarations; 9/9)

creationDate

Type:	xsd:dateTime, predefined, simple content
Defined:	locally within recurrenceRuleBodyBaseType complexType

This is required in order to exactly determine which timezone recurrence rule to use. We cannot use the startTime of the event because of the ability to create events in the past and in the future.

XML Source (see within schema source)

<xsd:element name="creationDate" type="xsd:dateTime">

<xsd:annotation>

<xsd:documentation>

This is required in order to exactly determine which timezone recurrence rule to use.
We cannot use the startTime of the event because of the ability to create events in
the past and in the future.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

firstDayOfWeek

Type:	dayOfWeekEnum, simple content
Defined:	locally within recurrenceRuleBodyBaseType complexType

This stores what the first day of the week is for this user. Typical values are (su) Sunday or (mo) Monday. Recurrence rule's specified FirstDOW for calculating the recurrence expansion. Allows recurring meetings to be expanded in the organizer's FirstDOW instead of the invitee's FirstDOW. Outlook and ICAL Equivalents: FirstDOW

XML Source (see within schema source)

<xsd:element name="firstDayOfWeek" type="dayOfWeekEnum">

<xsd:annotation>

<xsd:documentation>

This stores what the first day of the week is for this
user. Typical values are (su) Sunday or (mo) Monday.

Recurrence rule's specified FirstDOW for calculating the recurrence expansion.
Allows recurring meetings to be expanded in the organizer's FirstDOW instead
of the invitee's FirstDOW.

Outlook and ICAL Equivalents

: FirstDOW

</xsd:documentation>

</xsd:annotation>

</xsd:element>

isLeapYear

Type:	xsd:boolean, predefined, simple content
Defined:	locally within recurrenceRuleBodyBaseType complexType

[International calendar support] It is possible to derive isLeapYear from leapMonthValue, but .NET Calendar stores both separately. See leapMonthValue for a use-case scenario.

XML Source (see within schema source)

<xsd:element maxOccurs="1" minOccurs="0" name="isLeapYear" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

[International calendar support]

It is possible to derive isLeapYear from leapMonthValue, but .NET Calendar stores both separately.
See leapMonthValue for a use-case scenario.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

leapMonthValue

Type:	monthValueEnum, simple content
Defined:	locally within recurrenceRuleBodyBaseType complexType

[International calendar support] <leapMonthValue> cannot be derived from a particular year and thus must be stored. For example, a user creates a recurrence on a Hebrew Lunar calendar. The year is a leap year and it has 13 months. In that year, the leapMonthValue is 7.

XML Source (see within schema source)

<xsd:element maxOccurs="1" minOccurs="0" name="leapMonthValue" type="monthValueEnum">

<xsd:annotation>

<xsd:documentation>

[International calendar support]

<leapMonthValue> cannot be derived from a particular year and thus must be stored. For
example, a user creates a recurrence on a Hebrew Lunar calendar. The year is a leap year and it
has 13 months. In that year, the leapMonthValue is 7.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

repeat

Type:	repeatRuleType, complex content
Defined:	locally within recurrenceRuleBodyBaseType complexType

XML Source (see within schema source)

<xsd:element name="repeat" type="repeatRuleType"/>

repeatForever

Type:	xsd:boolean, predefined, simple content
Defined:	locally within recurrenceRuleBodyBaseType complexType

Overrides the windowEnd date and specifies that this recurrence repeats forever. Client implementations cannot depend on date values repeating forever, like 23:59:59pm Dec 31, 9999 or 23:59 Aug 31, 4500.

XML Source (see within schema source)

<xsd:element maxOccurs="1" minOccurs="0" name="repeatForever" type="xsd:boolean">

<xsd:annotation>

<xsd:documentation>

Overrides the windowEnd date and specifies that this recurrence repeats
forever. Client implementations cannot depend on date values
repeating forever, like 23:59:59pm Dec 31, 9999 or 23:59 Aug 31, 4500.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

repeatInstances

Type:	xsd:int, predefined, simple content
Defined:	locally within recurrenceRuleBodyBaseType complexType

Overrides the windowEnd date and specifies that this recurrence repeats for the specified number of instances. repeatInstances and repeatForever are mutually exclusive, but repeatInstances will override repeatForever for errant schemas.

XML Source (see within schema source)

<xsd:element maxOccurs="1" minOccurs="0" name="repeatInstances" type="xsd:int">

<xsd:annotation>

<xsd:documentation>

Overrides the windowEnd date and specifies that this recurrence repeats
for the specified number of instances. repeatInstances and repeatForever
are mutually exclusive, but repeatInstances will override repeatForever
for errant schemas.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

tzid

Type:	tzidEnum, simple content
Defined:	locally within recurrenceRuleBodyBaseType complexType

Identifies the time zone for this recurring event. All dateTime information in this event is stored in UTC (converted from the local time zone defined by the time zone sub-schema). If this field is absent, the recurring event is assumed to be recurring in UTC time. However, it is only a floating recurring event if the <floating> attribute is set. @afterDay is used as a placeholder for v1. @afterDay will not be use for .NET My Services V1. <pre> <timeZone floating="..." id="...">1..1 <standardBias>1..1</standardBias> <additionalDaylightBias>0..1</additionalDaylightBias> <standardDate>0..1 <transitionRule weekdayOfMonth="..." day="..." dayOfMonth="..." month="..." afterDay="...">1..1</transitionRule> <transitionTime>1..1</transitionTime> </standardDate> <daylightDate>0..1 <transitionRule weekdayOfMonth="..." day="..." dayOfMonth="..." month="..." afterDay="...">1..1</transitionRule> <transitionTime>1..1</transitionTime> </daylightDate> </timeZone> </pre>

XML Source (see within schema source)

<xsd:element maxOccurs="1" minOccurs="0" name="tzid" type="tzidEnum">

<xsd:annotation>

<xsd:documentation>

Identifies the time zone for this recurring event.

All dateTime information in
this event is stored in UTC

(converted from the local time zone defined
by the time zone sub-schema). If this field is absent, the recurring event is assumed
to be recurring in UTC time. However, it is only a

floating recurring event

if
the <floating> attribute is set.

@afterDay is used as a placeholder for v1. @afterDay will not be use for
.NET My Services V1.

<pre>

<timeZone floating="..."

id

="...">

1..1

1..1

</standardBias>
<additionalDaylightBias>

0..1

</additionalDaylightBias>
<standardDate>

0..1

1..1

</transitionRule>
<transitionTime>

1..1

</transitionTime>
</standardDate>
<daylightDate>

0..1

1..1

</transitionRule>
<transitionTime>

1..1

</transitionTime>
</daylightDate>
</timeZone>

</pre>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

windowEnd

Type:	xsd:dateTime, predefined, simple content
Defined:	locally within recurrenceRuleBodyBaseType complexType

This dateTime indicates the end of the window over which the recurrence occurs. This is stored in UTC. Maximum range is January 1, 1753 to December 31, 9999 to an accuracy of 3.33 milliseconds. TODO: windowEnd, repeatForever, repeatInstances should be xsd:choice when implemented by XDB.

XML Source (see within schema source)

<xsd:element maxOccurs="1" minOccurs="0" name="windowEnd" type="xsd:dateTime">

<xsd:annotation>

<xsd:documentation>

This dateTime indicates the end of the window over which the recurrence
occurs. This is stored in UTC. Maximum range is January 1, 1753 to
December 31, 9999 to an accuracy of 3.33 milliseconds.

TODO:

windowEnd, repeatForever, repeatInstances should be xsd:choice when implemented by XDB.

</xsd:documentation>

</xsd:annotation>

</xsd:element>