[Telepathy-commits] [telepathy-spec/master] CDO: rename Closed signal to Finished; document that Claim can raise NotYours.

[Simon McVittie]

CD: rename change notification to DispatchOperationFinished to be consistent
---
 spec/Channel_Dispatch_Operation.xml |   18 ++++++++++++++----
 spec/Channel_Dispatcher.xml         |    8 ++++----
 2 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/spec/Channel_Dispatch_Operation.xml b/spec/Channel_Dispatch_Operation.xml
index aec6015..334df5f 100644
--- a/spec/Channel_Dispatch_Operation.xml
+++ b/spec/Channel_Dispatch_Operation.xml
@@ -191,7 +191,7 @@
 
         <p>If successful, this method will cause the ChannelDispatchOperation
           object to disappear, emitting
-          <tp:member-ref>Closed</tp:member-ref>.</p>
+          <tp:member-ref>Finished</tp:member-ref>.</p>
 
         <p>However, this method may fail because the dispatch has already been
           completed and the object has already gone. If this occurs, it
@@ -244,7 +244,7 @@
 
         <p>If successful, this method will cause the ChannelDispatchOperation
           object to disappear, emitting
-          <tp:member-ref>Closed</tp:member-ref>, in the same way as for
+          <tp:member-ref>Finished</tp:member-ref>, in the same way as for
           <tp:member-ref>HandleWith</tp:member-ref>.</p>
 
         <p>This method may fail because the dispatch operation has already
@@ -252,12 +252,22 @@
           MUST NOT attempt to interact with the channels further in this
           case.</p>
 
-        <p>(FIXME: list some possible errors)</p>
+        <p>(FIXME: list some other possible errors)</p>
       </tp:docstring>
 
+      <tp:possible-errors>
+        <tp:error name="org.freedesktop.Telepathy.Error.NotYours">
+          <tp:docstring>
+            At the time that Claim was called, this dispatch operation was
+            processing a call to HandleWith which has now succeeded, so
+            some Handler nominated by another approver is now responsible for
+            the channel.
+          </tp:docstring>
+        </tp:error>
+      </tp:possible-errors>
     </method>
 
-    <signal name="Closed" tp:name-for-bindings="Closed">
+    <signal name="Finished" tp:name-for-bindings="Finished">
       <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
         <p>Emitted when this dispatch operation finishes. The dispatch
           operation is no longer present and further methods must not be
diff --git a/spec/Channel_Dispatcher.xml b/spec/Channel_Dispatcher.xml
index 1f64d31..9d3ec7e 100644
--- a/spec/Channel_Dispatcher.xml
+++ b/spec/Channel_Dispatcher.xml
@@ -295,16 +295,16 @@
       </arg>
     </signal>
 
-    <signal name="DispatchOperationClosed"
-      tp:name-for-bindings="Dispatch_Operation_Closed">
+    <signal name="DispatchOperationFinished"
+      tp:name-for-bindings="Dispatch_Operation_Finished">
       <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
         Emitted when a dispatch operation finishes (i.e. exactly once per
         emission of <tp:dbus-ref
-          namespace="org.freedesktop.Telepathy">ChannelDispatchOperation.DRAFT.Closed</tp:dbus-ref>).
+          namespace="org.freedesktop.Telepathy">ChannelDispatchOperation.DRAFT.Finished</tp:dbus-ref>).
 
         <tp:rationale>
           Strictly speaking this is redundant with
-          ChannelDispatchOperation.Closed, but it provides full
+          ChannelDispatchOperation.Finished, but it provides full
           change-notification for the DispatchOperations property.
         </tp:rationale>
       </tp:docstring>
-- 
1.5.6.5