summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuillaume Desmottes <guillaume.desmottes@collabora.co.uk>2013-10-14 16:00:47 -0400
committerGuillaume Desmottes <guillaume.desmottes@collabora.co.uk>2013-10-15 13:16:12 -0400
commitece958f2f332292fb4373ccf8f2f5f59cf584eba (patch)
treed96fbe5e70a7b6a70f68ef9f6e483f14dfddacae
parent9d4afccae63ab87bcfdb1760b907a963a146dfb3 (diff)
IRC_Command: add Send() example
I deliberately picked an example using a non standard IRC command as this interface is not meant to be used as a substitute for proper Telepathy API.
-rw-r--r--extensions/Connection_Interface_IRC_Command1.xml3
1 files changed, 3 insertions, 0 deletions
diff --git a/extensions/Connection_Interface_IRC_Command1.xml b/extensions/Connection_Interface_IRC_Command1.xml
index c46791b..b781380 100644
--- a/extensions/Connection_Interface_IRC_Command1.xml
+++ b/extensions/Connection_Interface_IRC_Command1.xml
@@ -29,6 +29,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
</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>
</tp:docstring>
<tp:possible-errors>
<tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>