[CalendarServer-changes] [8819] CalendarServer/trunk/doc/Extensions

source_changes at macosforge.org source_changes at macosforge.org
Tue Mar 6 07:15:52 PST 2012


Revision: 8819
          http://trac.macosforge.org/projects/calendarserver/changeset/8819
Author:   cdaboo at apple.com
Date:     2012-03-06 07:15:52 -0800 (Tue, 06 Mar 2012)
Log Message:
-----------
Spec update.

Modified Paths:
--------------
    CalendarServer/trunk/doc/Extensions/caldav-notifications.txt
    CalendarServer/trunk/doc/Extensions/caldav-notifications.xml

Modified: CalendarServer/trunk/doc/Extensions/caldav-notifications.txt
===================================================================
--- CalendarServer/trunk/doc/Extensions/caldav-notifications.txt	2012-03-06 06:56:51 UTC (rev 8818)
+++ CalendarServer/trunk/doc/Extensions/caldav-notifications.txt	2012-03-06 15:15:52 UTC (rev 8819)
@@ -3,7 +3,7 @@
 
 Calendar Server Extension                                       C. Daboo
                                                               Apple Inc.
-                                                        February 9, 2012
+                                                           March 6, 2012
 
 
                   CalDAV: Calendar User Notifications
@@ -54,7 +54,7 @@
 
 Daboo                                                           [Page 1]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
 Table of Contents
@@ -110,7 +110,7 @@
 
 Daboo                                                           [Page 2]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
 1.  Introduction
@@ -166,7 +166,7 @@
 
 Daboo                                                           [Page 3]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    The notification collection referenced by the CS:notification-URL
@@ -222,7 +222,7 @@
 
 Daboo                                                           [Page 4]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
 4.1.1.  CS:notification-URL Property
@@ -278,7 +278,7 @@
 
 Daboo                                                           [Page 5]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    COPY/MOVE behavior:  This property value MUST be preserved in COPY
@@ -334,7 +334,7 @@
 
 Daboo                                                           [Page 6]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    Definition:
@@ -353,12 +353,14 @@
 
    Description:  Contains the date-time stamp corresponding to the
       creation of a notification message, using the format defined in
-      [RFC3339].
+      [RFC3339], or the "compact" format without "-" and ":" characters
+      between date and time elements, respectively.
 
    Definition:
 
    <!ELEMENT dtstamp (#PCDATA)>
-   <!-- Value is a date-time in UTZ as per [RFC3339] -->
+   <!-- Value is a date-time in UTZ as per [RFC3339] with
+        "compact" format allowed.-->
 
 
 5.  Notification Definitions
@@ -386,11 +388,9 @@
 
 
 
-
-
 Daboo                                                           [Page 7]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
 5.1.1.  CS:systemstatus Element Definition
@@ -446,7 +446,7 @@
 
 Daboo                                                           [Page 8]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    some cases these may be warnings (e.g., a user getting to 80% of
@@ -502,7 +502,7 @@
 
 Daboo                                                           [Page 9]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    <?xml version="1.0" encoding="UTF-8"?>
@@ -558,7 +558,7 @@
 
 Daboo                                                          [Page 10]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    next synchronize the notification collection.
@@ -614,7 +614,7 @@
 
 Daboo                                                          [Page 11]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
       to list details of the changes.  If no CS:calendar-changes element
@@ -654,25 +654,27 @@
           is the principal URI or email address of the user who made
           the change. -->
 
-     <!ELEMENT collection-changes (DAV:href, DAV:prop?, child-created?,
-                                   child-updated? child-deleted?>
+     <!ELEMENT collection-changes (DAV:href, changed-by*, DAV:prop?,
+                                   child-created?, child-updated?,
+                                   child-deleted?>
+       <!-- When coalescing changes from multiple users, the changed-by
+            element can appear more than once. -->
+
        <!ELEMENT child-created CDATA>
        <!ELEMENT child-updated CDATA>
        <!ELEMENT child-deleted CDATA>
        <!-- Each of the three elements above MUST contain a positive,
             non-zero integer value indicate the total number of changes
-            being reported for the collection. -->
 
 
 
-
-
-
 Daboo                                                          [Page 12]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
+            being reported for the collection. -->
+
    Example:  This is an example of the body of a notification resource
       for changes where one resource has been created, two updated, and
       one deleted.  One of the updated resources elements contains
@@ -722,11 +724,9 @@
 
 
 
-
-
 Daboo                                                          [Page 13]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    Example:  This example is the same as the previous one, except that
@@ -782,7 +782,7 @@
 
 Daboo                                                          [Page 14]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    <!ELEMENT calendar-changes (recurrence+) >
@@ -838,7 +838,7 @@
 
 Daboo                                                          [Page 15]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    <CS:calendar-changes xmlns:CS="http://calendarserver.org/ns/">
@@ -894,7 +894,7 @@
 
 Daboo                                                          [Page 16]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
       "EXDATE" properties.
@@ -950,7 +950,7 @@
 
 Daboo                                                          [Page 17]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    <!ELEMENT deleted-details ((deleted-component,
@@ -971,12 +971,15 @@
           instances existed at the time of deletion. -->
 
      <!ELEMENT deleted-next-instance CDATA>
-     <!-- If present indicates the UTC date-time, or date value for
-          the "RECURRENCE-ID" of the next future instance at the time
-          of deletion. If not present, then there were no future
-          instances at the time of deletion. -->
+     <!ATTLIST deleted-next-instance tzid PCDATA>
+     <!-- If present, indicates when the next deleted instance would
+          have occurred. For a VEVENT that would be the DTSTART value,
+          for a VTODO that would be either DTSTART or DUE, if present.
+          In each case the value must match the value in the iCalendar
+          data, and any TZID iCalendar property parameter value must
+          be included in the tzid XML element attribute value. -->
 
-     <!ELEMENT deleted-had-more-instances CDATA>
+     <!ELEMENT deleted-had-more-instances EMPTY>
      <!-- If present indicates that there was more than one future
           instances still to occur at the time of deletion. -->
 
@@ -990,25 +993,24 @@
    <CS:deleted-details xmlns:CS="http://calendarserver.org/ns/">
      <CS:deleted-component>VEVENT</CS:deleted-component>
      <CS:deleted-summary>Birthday Party</CS:deleted-summary>
-     <CS:deleted-next-instance>20120505</CS:deleted-next-instance>
+     <CS:deleted-next-instance tzid="America/New_York
+     >20120505T120000</CS:deleted-next-instance>
    </CS:deleted-details>
 
    Example:  This example indicates deletion of a calendar.
 
    <CS:deleted-details xmlns:CS="http://calendarserver.org/ns/">
      <CS:deleted-displayname>Holidays</CS:deleted-displayname>
-   </CS:deleted-details>
 
 
 
-
-
-
 Daboo                                                          [Page 18]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
+   </CS:deleted-details>
+
 5.3.4.  CS:notify-changes Property
 
    Name:  notify-changes
@@ -1058,11 +1060,9 @@
 
 
 
-
-
 Daboo                                                          [Page 19]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
 7.  IANA Considerations
@@ -1118,7 +1118,7 @@
 
 Daboo                                                          [Page 20]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    <?xml version="1.0" encoding="UTF-8"?>
@@ -1174,7 +1174,7 @@
 
 Daboo                                                          [Page 21]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
 A.3.  Resource Updated - Parameter Change
@@ -1230,7 +1230,7 @@
 
 Daboo                                                          [Page 22]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    <?xml version="1.0" encoding="UTF-8"?>
@@ -1286,7 +1286,7 @@
 
 Daboo                                                          [Page 23]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    <?xml version="1.0" encoding="UTF-8"?>
@@ -1342,7 +1342,7 @@
 
 Daboo                                                          [Page 24]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    <?xml version="1.0" encoding="UTF-8"?>
@@ -1398,7 +1398,7 @@
 
 Daboo                                                          [Page 25]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
    <?xml version="1.0" encoding="UTF-8"?>
@@ -1454,7 +1454,7 @@
 
 Daboo                                                          [Page 26]
 
-                        CalDAV User Notifications          February 2012
+                        CalDAV User Notifications             March 2012
 
 
 Author's Address

Modified: CalendarServer/trunk/doc/Extensions/caldav-notifications.xml
===================================================================
--- CalendarServer/trunk/doc/Extensions/caldav-notifications.xml	2012-03-06 06:56:51 UTC (rev 8818)
+++ CalendarServer/trunk/doc/Extensions/caldav-notifications.xml	2012-03-06 15:15:52 UTC (rev 8819)
@@ -165,12 +165,13 @@
                     <t hangText="Name:">dtstamp</t>
                     <t hangText="Namespace:">http://calendarserver.org/ns/</t>
                     <t hangText="Purpose:">Date-time stamp.</t>
-                    <t hangText="Description:">Contains the date-time stamp corresponding to the creation of a notification message, using the format defined in <xref target="RFC3339"/>.</t>
+                    <t hangText="Description:">Contains the date-time stamp corresponding to the creation of a notification message, using the format defined in <xref target="RFC3339"/>, or the "compact" format without "-" and ":" characters between date and time elements, respectively.</t>
                     <t hangText="Definition:">
                       <figure>
                         <artwork><![CDATA[
 <!ELEMENT dtstamp (#PCDATA)>
-<!-- Value is a date-time in UTZ as per [RFC3339] -->]]></artwork>
+<!-- Value is a date-time in UTZ as per [RFC3339] with 
+     "compact" format allowed.-->]]></artwork>
                       </figure>
                     </t>
                   </list>
@@ -341,8 +342,12 @@
        is the principal URI or email address of the user who made
        the change. -->
 
-  <!ELEMENT collection-changes (DAV:href, DAV:prop?, child-created?,
-                                child-updated? child-deleted?>
+  <!ELEMENT collection-changes (DAV:href, changed-by*, DAV:prop?,
+                                child-created?, child-updated?,
+                                child-deleted?>
+    <!-- When coalescing changes from multiple users, the changed-by
+         element can appear more than once. -->
+
     <!ELEMENT child-created CDATA>
     <!ELEMENT child-updated CDATA>
     <!ELEMENT child-deleted CDATA>
@@ -538,12 +543,15 @@
        instances existed at the time of deletion. -->
 
   <!ELEMENT deleted-next-instance CDATA>
-  <!-- If present indicates the UTC date-time, or date value for
-       the "RECURRENCE-ID" of the next future instance at the time
-       of deletion. If not present, then there were no future
-       instances at the time of deletion. -->
+  <!ATTLIST deleted-next-instance tzid PCDATA>
+  <!-- If present, indicates when the next deleted instance would
+       have occurred. For a VEVENT that would be the DTSTART value,
+       for a VTODO that would be either DTSTART or DUE, if present.
+       In each case the value must match the value in the iCalendar
+       data, and any TZID iCalendar property parameter value must
+       be included in the tzid XML element attribute value. -->
 
-  <!ELEMENT deleted-had-more-instances CDATA>
+  <!ELEMENT deleted-had-more-instances EMPTY>
   <!-- If present indicates that there was more than one future
        instances still to occur at the time of deletion. -->
 
@@ -559,7 +567,8 @@
 <CS:deleted-details xmlns:CS="http://calendarserver.org/ns/">
   <CS:deleted-component>VEVENT</CS:deleted-component>
   <CS:deleted-summary>Birthday Party</CS:deleted-summary>
-  <CS:deleted-next-instance>20120505</CS:deleted-next-instance>
+  <CS:deleted-next-instance tzid="America/New_York
+  >20120505T120000</CS:deleted-next-instance>
 </CS:deleted-details>]]></artwork>
                             </figure>
                         </t>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20120306/efbdef92/attachment-0001.html>


More information about the calendarserver-changes mailing list