From 38c54d328333e0d99d1e5627ce479c9b3f41a945 Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Fri, 17 Dec 2010 10:52:58 +0000 Subject: [PATCH] Describe the (unusual!) expected channel class for ContactSearch channels --- spec/Channel_Type_Contact_Search.xml | 23 +++++++++++++++++++++-- spec/Connection_Interface_Requests.xml | 5 ++++- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/spec/Channel_Type_Contact_Search.xml b/spec/Channel_Type_Contact_Search.xml index fefa77a..98789ab 100644 --- a/spec/Channel_Type_Contact_Search.xml +++ b/spec/Channel_Type_Contact_Search.xml @@ -31,12 +31,31 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.A channel type for searching server-stored user directories. A new channel should be requested by a client for each search attempt, and closed when the search is completed or the required result has been - found. Channels of this type should have + +

Connections that support contact search channels SHOULD have an entry + in RequestableChannelClasses with the ChannelType fixed to this + interface, and no other fixed properties. That requestable + channel class MAY also have the Server and Limit properties in its + list of allowed properties, depending on the protocol.

+ + +

The requestable channel class would normally also have TargetHandleType fixed to + None, but the initial implementation of ContactSearch + (in telepathy-gabble) didn't do this.

+
+ +

All channels of this type should have TargetHandleType None (and hence TargetHandle 0 and TargetID - ""). Requests for channels of this type need only + "").

+ +

Requests for channels of this type need only optionally specify the Server property (if it is an allowed property in the connection's RequestableChannelClasses).

diff --git a/spec/Connection_Interface_Requests.xml b/spec/Connection_Interface_Requests.xml index 2f233fa..9d94d44 100644 --- a/spec/Connection_Interface_Requests.xml +++ b/spec/Connection_Interface_Requests.xml @@ -486,7 +486,10 @@ org.freedesktop.Telepathy.Channel.ChannelType and org.freedesktop.Telepathy.Channel.TargetHandleType. -

+ (One exception is that ContactSearch channels do not have + TargetHandleType = NONE in their requestable channel classes, + for historical reasons.)

-- 1.7.8.3