diff options
Diffstat (limited to 'extensions')
| -rw-r--r-- | extensions/Channel_Type_FileTransfer_Future.xml | 67 | ||||
| -rw-r--r-- | extensions/Connection_Future.xml | 110 | ||||
| -rw-r--r-- | extensions/Connection_Interface_Addressing.xml | 245 | ||||
| -rw-r--r-- | extensions/Gabble_Plugin_Console.xml | 2 | ||||
| -rw-r--r-- | extensions/Makefile.am | 5 | ||||
| -rw-r--r-- | extensions/all.xml | 15 |
6 files changed, 2 insertions, 442 deletions
diff --git a/extensions/Channel_Type_FileTransfer_Future.xml b/extensions/Channel_Type_FileTransfer_Future.xml deleted file mode 100644 index b155136e0..000000000 --- a/extensions/Channel_Type_FileTransfer_Future.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" ?> -<node name="/Channel_Type_FileTransfer_Future" - xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - <tp:copyright>Copyright (C) 2010 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.Channel.Type.FileTransfer.FUTURE" - tp:causes-havoc="a staging area for future File Transfer Channel functionality"> - - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>This interface contains functionality which we intend to incorporate - into the File Transfer Channel interface in future. - It should be considered to be conceptually part of the core - File Transfer Channel interface, but without API or ABI guarantees.</p> - - <tp:rationale> - <p>If we add new functionality to the Channel interface, libraries - that use generated code (notably telepathy-glib) will have it as - part of their ABI forever, meaning we can't make incompatible - changes. By using this interface as a staging area for future - Channel functionality, we can try out new properties, signals - and methods as application-specific extensions, then merge them - into the core Channel interface when we have enough implementation - experience to declare them to be stable.</p> - - <p>The name is by analogy to Python's <code>__future__</code> - pseudo-module.</p> - </tp:rationale> - </tp:docstring> - - <property name="FileCollection" tp:name-for-bindings="FileCollection" - type="s" access="read"> - <tp:added version="0.19.2">(in Channel.Type.FileTransfer.FUTURE - pseudo-interface)</tp:added> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>The FileCollection to which this channel belongs.</p> - - <p>A channel's FileCollection property can never change.</p> - - <p>At least on GTalk and apparently also on iChat the user can - send a set of files to a contact and that contact can then - pick and choose which files to actually receive. - - The CM should emit all new FT channels belonging to one collection - at the same time, UIs supporting this feature can then - bundle all these channels together in some way and show a - nice UI. UIs not supporting it will treat them as seperate - transfers, which is not great but a reasonable fallback</p> - </tp:docstring> - </property> - - </interface> -</node> -<!-- vim:set sw=2 sts=2 et ft=xml: --> diff --git a/extensions/Connection_Future.xml b/extensions/Connection_Future.xml deleted file mode 100644 index 110479832..000000000 --- a/extensions/Connection_Future.xml +++ /dev/null @@ -1,110 +0,0 @@ -<?xml version="1.0" ?> -<node name="/Connection_FUTURE" - xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" - > - <tp:copyright>Copyright © 2009 Collabora Limited</tp:copyright> - <tp:copyright>Copyright © 2009 Nokia Corporation</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.Connection.FUTURE" - tp:causes-havoc='experimental'> - <tp:requires interface="org.freedesktop.Telepathy.Connection"/> - - <method name="EnsureSidecar" tp:name-for-bindings="Ensure_Sidecar"> - <tp:added version="0.19.UNRELEASED"/> - - <arg direction="in" name="Main_Interface" type="s" - tp:type="DBus_Interface"> - <tp:docstring> - The "primary" interface implemented by an object attached - to a connection. For example, a Gabble plugin implementing - fine-grained control of XEP-0016 privacy lists might expose an object - implementing <tt>com.example.PrivacyLists</tt>. - </tp:docstring> - </arg> - - <arg direction="out" name="Path" type="o"> - <tp:docstring>The object path of the sidecar, exported by the same bus - name as the Connection to which it is attached.</tp:docstring> - </arg> - <arg direction="out" name="Properties" type="a{sv}" - tp:type="Qualified_Property_Value_Map"> - <tp:docstring>Immutable properties of the sidecar.</tp:docstring> - </arg> - - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>Request an object with a particular interface providing additional - connection-specific functionality, together with its immutable - properties. These will often be implemented by plug-ins to the - connection managers; for example, support for an XMPP XEP for which - no generic Telepathy interface exists might be implemented by a - Gabble plugin exposing a sidecar with a particular interface.</p> - - <p>This method may be called at any point during the lifetime of a - connection, even before its <tp:type>Connection_Status</tp:type> - changes to Connected. It MAY take a long time to - return—perhaps it needs to wait for a connection to be established - and for all the services supported by the server to be discovered - before determining whether necessary server-side support is - available—so callers SHOULD override the default method timeout (25 - seconds) with a much higher value (perhaps even MAX_INT32, meaning - “no timeout” in recent versions of libdbus).</p> - - <tp:rationale> - <p>There is an implicit assumption that any connection - manager plugin will only want to export one “primary” object per - feature it implements, since there is a one-to-one mapping between - interface and object. This is reasonable since Sidecars are - (intended to be) analogous to extra interfaces on the connection, - providing once-per-connection shared functionality; it also makes - client code straightforward (look up the interface you care about - in a dictionary, build a proxy object from the value). More - “plural” plugins are likely to want to implement new types of - <tp:dbus-ref - namespace="org.freedesktop.Telepathy">Channel</tp:dbus-ref> - instead.</p> - </tp:rationale> - </tp:docstring> - - <tp:error name="org.freedesktop.Telepathy.Error.NotImplemented"> - <tp:docstring> - The requested sidecar is not implemented by this connection manager, - or a necessary server-side component does not exist. (FIXME: split - these two errors out? Then again, once we list the guaranteed and - possible sidecars on a Protocol object, clients can tell the - difference themselves, because they shouldn't be calling this in the - first case.) - </tp:docstring> - </tp:error> - - <tp:error name="org.freedesktop.Telepathy.Error.ServiceBusy"> - <tp:docstring> - A server-side component needed by the requested sidecar reported it - is currently too busy, or did not respond for some - implementation-defined time. The caller may wish to try again later. - </tp:docstring> - </tp:error> - - <tp:error name="org.freedesktop.Telepathy.Error.Cancelled"> - <tp:docstring> - The connection was disconnected while the sidecar was being set up. - </tp:docstring> - </tp:error> - </method> - - </interface> -</node> diff --git a/extensions/Connection_Interface_Addressing.xml b/extensions/Connection_Interface_Addressing.xml deleted file mode 100644 index 2d8145f3c..000000000 --- a/extensions/Connection_Interface_Addressing.xml +++ /dev/null @@ -1,245 +0,0 @@ -<?xml version="1.0" ?> -<node name="/Connection_Interface_Addressing" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - <tp:copyright> Copyright (C) 2010 Collabora Limited </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.Connection.Interface.Addressing1" - tp:causes-havoc="experimental"> - <tp:requires interface="org.freedesktop.Telepathy.Connection"/> - <tp:requires interface="org.freedesktop.Telepathy.Connection.Interface.Contacts"/> - <tp:added version="0.19.12">(as draft)</tp:added> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>This interface deals with the multiple address types that can - refer to the same contact, such as vCard fields and URIs.</p> - - <p>It can be used to retrieve contacts with a specific addresses - through <tp:member-ref>GetContactsByVCardField</tp:member-ref> and - <tp:member-ref>GetContactsByURI</tp:member-ref>, as well as - defining the various addressing methods for a given contact - through this interface's contact attributes.</p> - </tp:docstring> - - <method name="GetContactsByVCardField" - tp:name-for-bindings="Get_Contacts_By_VCard_Field"> - <arg direction="in" name="Field" type="s"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>The vCard field of the addresses we are requesting. The - field name SHOULD be in lower case. Supported - fields can be found in - <tp:dbus-ref namespace="org.freedesktop.Telepathy.Protocol.Interface.Addressing">AddressableVCardFields</tp:dbus-ref>.</p> - - <p>The <code>url</code> vCard field MUST NOT appear here; see - <tp:member-ref>GetContactsByURI</tp:member-ref> instead.</p> - - <tp:rationale> - <p>In practice, protocols have a limited set of URI - schemes that make sense to resolve as a contact.</p> - </tp:rationale> - - </tp:docstring> - </arg> - <arg direction="in" name="Addresses" type="as"> - <tp:docstring> - The addresses to get contact handles for. The address types - should match the given vCard field. - </tp:docstring> - </arg> - <arg direction="in" name="Interfaces" type="as" - tp:type="DBus_Interface[]"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>A list of strings indicating which D-Bus interfaces the calling - process is interested in. All supported attributes from these - interfaces, whose values can be obtained without additional network - activity, will be in the reply.</p> - - <p>Attributes from this interface and from - <tp:dbus-ref>org.freedesktop.Telepathy.Connection</tp:dbus-ref> - are always returned, and need not be requested - explicitly.</p> - - <p>The behavior of this parameter is similar to the same - parameter in - <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface">Contacts.GetContactAttributes</tp:dbus-ref>.</p> - </tp:docstring> - </arg> - - <arg direction="out" type="a{su}" name="Requested" - tp:type="Addressing_Normalization_Map"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>A mapping from requested vCard addresses to the corresponding - contact handles.</p> - - <p>Requested addresses that are not valid or understood for this protocol - MUST be omitted from the mapping.</p> - </tp:docstring> - </arg> - - <arg direction="out" type="a{ua{sv}}" name="Attributes" - tp:type="Contact_Attributes_Map"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>A dictionary mapping the contact handles to contact attributes. - If any of the requested addresses are in fact invalid, they are - simply omitted from this mapping. If contact attributes are not - immediately known, the behaviour is defined by the interface; - the attribute should either be omitted from the result or - replaced with a default value.</p> - - <p>Requested addresses that are not valid or understood for this protocol - MUST be omitted from the mapping.</p> - - <p>Each contact's attributes will always include at least the - identifier that would be obtained by inspecting the handle - (<code>org.freedesktop.Telepathy.Connection/contact-id</code>). - </p> - </tp:docstring> - </arg> - - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>Request contacts and retrieve their attributes using a given field - in their vCards.</p> - - <p>The connection manager should record that these handles are in - use by the client who invokes this method, and must not - deallocate the handles until the client disconnects from the - bus or calls the - <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.ReleaseHandles</tp:dbus-ref> - method.</p> - </tp:docstring> - - <tp:possible-errors> - <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/> - </tp:possible-errors> - </method> - - <method name="GetContactsByURI" - tp:name-for-bindings="Get_Contacts_By_URI"> - <arg direction="in" name="URIs" type="as"> - <tp:docstring> - The URI addresses to get contact handles for. Supported - schemes can be found in - <tp:dbus-ref namespace="org.freedesktop.Telepathy.Protocol.Interface.Addressing">AddressableURISchemes</tp:dbus-ref>. - </tp:docstring> - </arg> - <arg direction="in" name="Interfaces" type="as" - tp:type="DBus_Interface[]"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>A list of strings indicating which D-Bus interfaces the calling - process is interested in. All supported attributes from these - interfaces, whose values can be obtained without additional network - activity, will be in the reply.</p> - - <p>Attributes from this interface and from - <tp:dbus-ref>org.freedesktop.Telepathy.Connection</tp:dbus-ref> - are always returned, and need not be requested - explicitly.</p> - - <p>The behavior of this parameter is similar to the same - parameter in - <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface">Contacts.GetContactAttributes</tp:dbus-ref>.</p> - </tp:docstring> - </arg> - - <arg direction="out" type="a{su}" name="Requested" - tp:type="Addressing_Normalization_Map"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>A mapping of requested URIs to the corresponding contact handles.</p> - - <p>Requested URIs that are not valid or understood for this protocol - MUST be omitted from the mapping.</p> - </tp:docstring> - </arg> - - <arg direction="out" type="a{ua{sv}}" name="Attributes" - tp:type="Contact_Attributes_Map"> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>A dictionary mapping the contact handles to contact attributes. - If any of the requested addresses are in fact invalid, they are - simply omitted from this mapping. If contact attributes are not - immediately known, the behaviour is defined by the interface; - the attribute should either be omitted from the result or - replaced with a default value.</p> - - <p>Requested URIs that are not valid or understood for this protocol - MUST be omitted from the mapping.</p> - - <p>Each contact's attributes will always include at least the - identifier that would be obtained by inspecting the handle - (<code>org.freedesktop.Telepathy.Connection/contact-id</code>). - </p> - </tp:docstring> - </arg> - - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>Request contacts and retrieve their attributes using URI addresses.</p> - - <p>The connection manager should record that these handles are in - use by the client who invokes this method, and must not - deallocate the handles until the client disconnects from the - bus or calls the - <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.ReleaseHandles</tp:dbus-ref> - method.</p> - </tp:docstring> - - <tp:possible-errors> - <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/> - </tp:possible-errors> - </method> - - <tp:mapping name="VCard_Field_Address_Map" array-name=""> - <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>A mapping of vCard fields and addresses that repreent - the given contact.</p> - </tp:docstring> - <tp:member type="s" name="VCard_Field"/> - <tp:member type="s" name="Address"/> - </tp:mapping> - - <tp:contact-attribute name="addresses" type="a{ss}" - tp:type="VCard_Field_Address_Map"> - <tp:docstring> - The various vCard addresses that identify this contact. - </tp:docstring> - </tp:contact-attribute> - - <tp:contact-attribute name="uris" type="as"> - <tp:docstring> - The various URI addresses that identify this contact. - </tp:docstring> - </tp:contact-attribute> - - <tp:mapping name="Addressing_Normalization_Map"> - <tp:docstring> - A map from URIs/vCard addresses to the corresponding handle. - </tp:docstring> - <tp:added version="0.25.UNRELEASED"/> - - <tp:member type="s" name="Requested_String"> - <tp:docstring> - The URI or vCard address that has been requested by - <tp:member-ref>GetContactsByVCardField</tp:member-ref> or - <tp:member-ref>GetContactsByURI</tp:member-ref>. - </tp:docstring> - </tp:member> - <tp:member type="u" name="Handle" tp:type="Contact_Handle"> - <tp:docstring> - A nonzero handle. - </tp:docstring> - </tp:member> - </tp:mapping> - - </interface> -</node> -<!-- vim:set sw=2 sts=2 et ft=xml: --> diff --git a/extensions/Gabble_Plugin_Console.xml b/extensions/Gabble_Plugin_Console.xml index 1e3b52385..a2d94ca0c 100644 --- a/extensions/Gabble_Plugin_Console.xml +++ b/extensions/Gabble_Plugin_Console.xml @@ -23,7 +23,7 @@ <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="true"/> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>A sidecar interface providing an XMPP console.</p> + <p>A channel type providing an XMPP console.</p> </tp:docstring> <method name="SendIQ" tp:name-for-bindings="Send_IQ"> diff --git a/extensions/Makefile.am b/extensions/Makefile.am index b435ae3f4..70210adf8 100644 --- a/extensions/Makefile.am +++ b/extensions/Makefile.am @@ -2,9 +2,6 @@ tools_dir = $(top_srcdir)/tools EXTRA_DIST = \ all.xml \ - Channel_Type_FileTransfer_Future.xml \ - Connection_Future.xml \ - Connection_Interface_Addressing.xml \ Connection_Interface_Gabble_Decloak.xml \ Gabble_Plugin_Console.xml \ Gabble_Plugin_Gateways.xml \ @@ -49,7 +46,7 @@ DROP_NAMESPACE = sed -e 's@xmlns:tp="http://telepathy\.freedesktop\.org/wiki/Dbu XSLTPROCFLAGS = --nonet --novalid _gen/all.xml: all.xml $(wildcard *.xml) Makefile.am - @$(mkdir_p) _gen + @$(MKDIR_P) _gen $(AM_V_GEN)$(PYTHON) $(tools_dir)/xincludator.py \ $< > $@.tmp && mv $@.tmp $@ diff --git a/extensions/all.xml b/extensions/all.xml index 99997d6db..b7c317422 100644 --- a/extensions/all.xml +++ b/extensions/all.xml @@ -33,14 +33,10 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</p> from="Telepathy specification"/> </tp:generic-types> -<xi:include href="Connection_Interface_Addressing.xml"/> - <xi:include href="OLPC_Buddy_Info.xml"/> <xi:include href="OLPC_Activity_Properties.xml"/> -<xi:include href="Channel_Type_FileTransfer_Future.xml"/> <xi:include href="Connection_Interface_Gabble_Decloak.xml"/> -<xi:include href="Connection_Future.xml"/> <xi:include href="Gabble_Plugin_Console.xml"/> <xi:include href="Gabble_Plugin_Gateways.xml"/> @@ -108,17 +104,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</p> <tp:external-type name="Connection_Status" type="u" from="Telepathy specification"/> - <!-- use types from Channel_Type_Streamed_Media.xml --> - <tp:enum name="Media_Stream_Type" type="u" - array-name="Media_Stream_Type_List"> - <tp:enumvalue suffix="Audio" value="0"> - <tp:docstring>An audio stream</tp:docstring> - </tp:enumvalue> - <tp:enumvalue suffix="Video" value="1"> - <tp:docstring>A video stream</tp:docstring> - </tp:enumvalue> - </tp:enum> - <!-- use types from generic-types.xml --> <tp:struct name="Socket_Address_IP" array-name="Socket_Address_IP_List"> <tp:docstring>An IP address and port.</tp:docstring> |