diff options
author | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2013-10-16 11:40:38 -0400 |
---|---|---|
committer | Guillaume Desmottes <guillaume.desmottes@collabora.co.uk> | 2013-10-16 11:40:38 -0400 |
commit | 3deb4f94fe62bd554a88f89980d0dff21ee2ad98 (patch) | |
tree | ea71a12efc6eb957742f06faf194ad8808915abe | |
parent | 896f45ca82a60c3f3439e75997bf717506b87acc (diff) |
add Connection_Interface_IRC_Command1
-rw-r--r-- | spec/Connection_Interface_IRC_Command1.xml | 53 | ||||
-rw-r--r-- | spec/all.xml | 1 |
2 files changed, 54 insertions, 0 deletions
diff --git a/spec/Connection_Interface_IRC_Command1.xml b/spec/Connection_Interface_IRC_Command1.xml new file mode 100644 index 00000000..1de53969 --- /dev/null +++ b/spec/Connection_Interface_IRC_Command1.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" ?> +<node name="/Connection_Interface_IRC_Command1" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <tp:copyright> Copyright (C) 2013 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.IRCCommand1" + tp:causes-havoc='not well-tested'> + <tp:requires interface="org.freedesktop.Telepathy.Connection"/> + <method name="Send" tp:name-for-bindings="Send"> + <arg direction="in" name="Command" type="s"> + <tp:docstring> + The command followed by its arguments. + </tp:docstring> + </arg> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>Send an arbitrary IRC command to the server.</p> + <p>For example, an IRC client receiving <code>/bip blreset</code> from + the user might call this method with <code>BIP blreset</code> as + argument which will send <code>BIP blreset</code> to the server.</p> + <p>The command is supplied in UTF-8 (because strings on D-Bus are + always UTF-8). It is transcoded into the connection's configured + character set, if different, before sending to the server.</p> + </tp:docstring> + <tp:possible-errors> + <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/> + <tp:error name="org.freedesktop.Telepathy.Error.NetworkError"/> + <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument"> + <tp:docstring> + The connection manager MAY raise this error for commands that + have a more appropriate D-Bus API. + </tp:docstring> + </tp:error> + </tp:possible-errors> + </method> + <tp:docstring> + An interface to send arbitrary IRC commands to the server. + </tp:docstring> + </interface> +</node> +<!-- vim:set sw=2 sts=2 et ft=xml: --> diff --git a/spec/all.xml b/spec/all.xml index abe13f70..8664db9a 100644 --- a/spec/all.xml +++ b/spec/all.xml @@ -108,6 +108,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <xi:include href="Connection_Interface_Power_Saving.xml"/> <xi:include href="Connection_Interface_Service_Point.xml"/> <xi:include href="Connection_Interface_Sidecars1.xml"/> + <xi:include href="Connection_Interface_IRC_Command1.xml"/> </tp:section> </tp:section> |