[Telepathy-commits] [telepathy-spec/master] Conn.I.Requests.CreateChannel: clarify the exclusivity of CreateChannel

Simon McVittie simon.mcvittie at collabora.co.uk
Wed Sep 10 05:20:09 PDT 2008


---
 spec/Connection_Interface_Requests.xml |   26 ++++++++++++++++++--------
 1 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/spec/Connection_Interface_Requests.xml b/spec/Connection_Interface_Requests.xml
index 932c4a6..249e724 100644
--- a/spec/Connection_Interface_Requests.xml
+++ b/spec/Connection_Interface_Requests.xml
@@ -96,7 +96,7 @@
 
     <method name="CreateChannel" tp:name-for-bindings="Create_Channel">
       <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
-        <p>Request that channels are created.</p>
+        <p>Request that an entirely new channel is created.</p>
 
         <tp:rationale>
           <p>There is deliberately no flag corresponding to the
@@ -185,13 +185,23 @@
           </tp:docstring>
         </tp:error>
         <tp:error name="org.freedesktop.Telepathy.Error.NotAvailable">
-          <tp:docstring>
-            The requested channel cannot be created, but in
-            principle, a similar request might succeed in future. For instance,
-            this might be because the requested contact is using a client
-            that lacks a particular feature, or because a channel matching the
-            request already exists and the protocol requires that only one
-            such channel can exist at a time.
+          <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+            <p>The requested channel cannot be created, but in
+              principle, a similar request might succeed in future.
+              For instance, this might be because:</p>
+
+            <ul>
+              <li>the requested contact is using a client
+                that lacks a particular feature</li>
+              <li>a channel matching the request already exists and the
+                protocol requires that only one such channel can exist at a
+                time</li>
+              <li>a channel matching the request has already been requested
+                (by a previous call to CreateChannel or
+                <tp:dbus-ref>EnsureChannel</tp:dbus-ref>)
+                and the protocol requires that only one such channel can exist
+                at a time</li>
+            </ul>
           </tp:docstring>
         </tp:error>
         <tp:error name="org.freedesktop.Telepathy.Error.Channel.Banned"/>
-- 
1.5.6.3




More information about the Telepathy-commits mailing list