From f390090fee81292a31f02086679b5fa331fd0c46 Mon Sep 17 00:00:00 2001
From: Simon McVittie <simon.mcvittie@collabora.co.uk>
Date: Mon, 30 Jan 2012 15:38:25 +0000
Subject: [PATCH] Protocol: add Sidecars interface

---
 spec/Protocol_Interface_Sidecars.xml |   60 ++++++++++++++++++++++++++++++++++
 spec/all.xml                         |    1 +
 2 files changed, 61 insertions(+), 0 deletions(-)
 create mode 100644 spec/Protocol_Interface_Sidecars.xml

diff --git a/spec/Protocol_Interface_Sidecars.xml b/spec/Protocol_Interface_Sidecars.xml
new file mode 100644
index 0000000..a32a577
--- /dev/null
+++ b/spec/Protocol_Interface_Sidecars.xml
@@ -0,0 +1,60 @@
+<?xml version="1.0" ?>
+<node name="/Protocol_Interface_Sidecars"
+  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+
+  <tp:copyright>Copyright © 2009-2012 Collabora Ltd.</tp:copyright>
+  <tp:license xmlns="http://www.w3.org/1999/xhtml">
+    <p>This library is free software; you can redistribute it and/or
+      modify it under the terms of the GNU Lesser General Public
+      License as published by the Free Software Foundation; either
+      version 2.1 of the License, or (at your option) any later version.</p>
+
+    <p>This library is distributed in the hope that it will be useful,
+      but WITHOUT ANY WARRANTY; without even the implied warranty of
+      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+      Lesser General Public License for more details.</p>
+
+    <p>You should have received a copy of the GNU Lesser General Public
+      License along with this library; if not, write to the Free Software
+      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+      02110-1301, USA.</p>
+  </tp:license>
+
+  <interface name="org.freedesktop.Telepathy.Protocol.Interface.Sidecars1"
+    tp:causes-havoc="experimental">
+    <tp:added version="0.UNRELEASED"/>
+    <tp:requires interface="org.freedesktop.Telepathy.Protocol"/>
+
+    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+      <p>An interface for protocols where "sidecar" objects might be
+        available.</p>
+    </tp:docstring>
+
+    <property name="PossibleSidecars"
+      tp:name-for-bindings="Possible_Sidecars"
+      type="as" access="read">
+      <tp:docstring>
+        <p>The sidecar interfaces for which
+          <tp:dbus-ref
+            namespace="org.freedesktop.Telepathy.Connection.FUTURE"
+            >EnsureSidecar</tp:dbus-ref>
+          might succeed on connections to this protocol.
+          This property is immutable.</p>
+
+        <tp:rationale>
+          <p>Some sidecar/plugin functionality will always appear, whereas
+            some depends on support from the server, so it will not work on
+            all connections. This interface does not distinguish between
+            the two.</p>
+        </tp:rationale>
+
+        <p>Connection managers with a <code>.manager</code> file and this
+          interface MUST cache this property in the protocol's section of the
+          <code>.manager</code> file, using the key
+          <code>PossibleSidecars</code>. The corresponding value
+          is a list of D-Bus interface names, each followed by a semicolon.</p>
+      </tp:docstring>
+    </property>
+
+  </interface>
+</node>
diff --git a/spec/all.xml b/spec/all.xml
index 72e4c49..2b2a018 100644
--- a/spec/all.xml
+++ b/spec/all.xml
@@ -37,6 +37,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
  <xi:include href="Protocol_Interface_Addressing.xml"/>
  <xi:include href="Protocol_Interface_Avatars.xml"/>
  <xi:include href="Protocol_Interface_Presence.xml"/>
+ <xi:include href="Protocol_Interface_Sidecars.xml"/>
 
  <tp:section name="Connection Object">
   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
-- 
1.7.8.3