[Telepathy-commits] [telepathy-spec/master] Mention Stop in ContactSearch preamble.

Will Thompson will.thompson at collabora.co.uk
Tue Feb 17 09:32:27 PST 2009


Also emphasise that the client really should Close() the channel.
---
 spec/Channel_Type_Contact_Search.xml |   14 ++++++++------
 1 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/spec/Channel_Type_Contact_Search.xml b/spec/Channel_Type_Contact_Search.xml
index 588098c..204ecf1 100644
--- a/spec/Channel_Type_Contact_Search.xml
+++ b/spec/Channel_Type_Contact_Search.xml
@@ -28,11 +28,6 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
         closed when the search is completed or the required result has been
         found in order to free unused handles.</p>
 
-      <p>The search can be cancelled at any time by calling the channel's
-        <tp:dbus-ref
-        namespace="org.freedesktop.Telepathy.Channel">Close</tp:dbus-ref>
-        method.</p>
-
       <p>Before searching, the
         <tp:member-ref>AvailableSearchKeys</tp:member-ref> property should be
         inspected to determine the valid search keys which can be provided to
@@ -44,7 +39,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
         <tp:member-ref>SearchResultReceived</tp:member-ref> signal is emitted
         for each contact found; when the search is complete, the search state
         will be set to <code>Completed</code>. If the search fails after Search
-        has been called, the state will change to <code>Failed</code>.</p>
+        has been called, the state will change to <code>Failed</code>.  A
+        running search can be cancelled by calling
+        <tp:member-ref>Stop</tp:member-ref>.</p>
+
+      <p>The client should call the channel's <tp:dbus-ref
+        namespace="org.freedesktop.Telepathy.Channel">Close</tp:dbus-ref>
+        method when it is finished with the channel, so that any handles held
+        only by the channel can be released.</p>
 
       <p>Each channel can only be used for a single search; a new channel
         should be requested for each subsequent search. Connection managers
-- 
1.5.6.5



More information about the telepathy-commits mailing list