twisted.protocols.jabber.client.IQ.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.protocols.jabber.client.IQ</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.protocols.html">Package protocols</a> ::
<a href="twisted.protocols.jabber.html">Package jabber</a> ::
<a href="twisted.protocols.jabber.client.html">Module client</a> ::
Class IQ
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.protocols.jabber.client.IQ.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IQ</h2>
<pre class="base-tree">
<code>object</code> --+
|
<a href="twisted.xish.domish.Element.html"><code>Element</code></a> --+
|
<b>IQ</b>
</pre><br />
<hr/>
<p>Wrapper for a Info/Query packet</p>
This provides the necessary functionality to send IQs and get notified
when a result comes back. It's a subclass from domish.Element, so you can
use the standard DOM manipulation calls to add data to the outbound
request.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.jabber.client.IQ.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>xmlstream</span>,
<span class=summary-sig-arg>type</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_resultEvent"></a><span class="summary-sig"><span class="summary-sig-name">_resultEvent</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>iq</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.jabber.client.IQ.html#addCallback" class="summary-sig-name"><code>addCallback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>fn</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Register a callback for notification when the IQ result is
available.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.jabber.client.IQ.html#send" class="summary-sig-name"><code>send</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>to</span>)</span></code>
<br />
Call this method to send this IQ request via the associated
XmlStream</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Element</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#__delitem__" class="summary-sig-name"><code>__delitem__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#__getattr__" class="summary-sig-name"><code>__getattr__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#__setitem__" class="summary-sig-name"><code>__setitem__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>,
<span class=summary-sig-arg>value</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Retrieve the first CData (content) node</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#_dqa" class="summary-sig-name"><code>_dqa</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>attr</span>)</span></code>
<br />
Dequalify an attribute key as needed</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#addChild" class="summary-sig-name"><code>addChild</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>node</span>)</span></code>
<br />
Add a child to this Element</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#addContent" class="summary-sig-name"><code>addContent</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>text</span>)</span></code>
<br />
Add some text data to this element</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#addElement" class="summary-sig-name"><code>addElement</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>defaultUri</span>,
<span class=summary-sig-arg>content</span>)</span></code>
<br />
Add a new child Element to this Element; preferred method</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#addRawXml" class="summary-sig-name"><code>addRawXml</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rawxmlstring</span>)</span></code>
<br />
Add a pre-serialized chunk o' XML as a child of this Element.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#addUniqueId" class="summary-sig-name"><code>addUniqueId</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Add a unique (across a given Python session) id attribute to this
Element</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#compareAttribute" class="summary-sig-name"><code>compareAttribute</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>attrib</span>,
<span class=summary-sig-arg>value</span>)</span></code>
<br />
Safely compare the value of an attribute against a provided value;
None-safe.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#elements" class="summary-sig-name"><code>elements</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Iterate across all children of this Element that are Elements</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#firstChildElement" class="summary-sig-name"><code>firstChildElement</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#getAttribute" class="summary-sig-name"><code>getAttribute</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>attribname</span>,
<span class=summary-sig-arg>default</span>)</span></code>
<br />
Retrieve the value of attribname, if it exists</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#hasAttribute" class="summary-sig-name"><code>hasAttribute</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>attrib</span>)</span></code>
<br />
Determine if the specified attribute exists</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#swapAttributeValues" class="summary-sig-name"><code>swapAttributeValues</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>left</span>,
<span class=summary-sig-arg>right</span>)</span></code>
<br />
Swap the values of two attribute</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.domish.Element.html#toXml" class="summary-sig-name"><code>toXml</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>prefixes</span>,
<span class=summary-sig-arg>closeElement</span>)</span></code>
<br />
Serialize this Element and all children to a string</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from object</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__delattr__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__getattribute__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__hash__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__reduce__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__setattr__</span>(...)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from type</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__new__</span>(...)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Element</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.xish.domish.Element.html#attributes"><code>attributes</code></a></b>: Dictionary of attributes associated with this Element.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.xish.domish.Element.html#children"><code>children</code></a></b>: List of child Elements and content</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.xish.domish.Element.html#defaultUri"><code>defaultUri</code></a></b>: URI this Element exists within</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.xish.domish.Element.html#name"><code>name</code></a></b>: Name of this Element</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>Element</code></font></td>
<td><b><a href="twisted.xish.domish.Element.html#parent"><code>parent</code></a></b>: Reference to the parent Element, if any.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.xish.domish.Element.html#uri"><code>uri</code></a></b>: URI of this Element's name</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>hemp.utility.CallbackList</code></font></td>
<td><b><a href="twisted.protocols.jabber.client.IQ.html#callbacks"><code>callbacks</code></a></b>: Callback list to be notified when response comes back</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Element</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.xish.domish.Element.html#_idCounter"><code>_idCounter</code></a></b> = <span title="0">0 </span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>xmlstream</span>,
<span class=sig-arg>type</span>=<span class=sig-default>'set'</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>xmlstream</b></code> -
XmlStream to use for transmission of this IQ
<br /><i>
(type=<code>XmlStream</code>)</i>
<dd><code><b>type</b></code> -
IQ type identifier ('get' or 'set')
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.xish.domish.Element.html#__init__"><code>twisted.xish.domish.Element.__init__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="addCallback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addCallback</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>fn</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kwargs</span>)</span>
</h3>
Register a callback for notification when the IQ result is
available.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="send"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">send</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>to</span>=<span class=sig-default>None</span>)</span>
</h3>
Call this method to send this IQ request via the associated
XmlStream
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>to</b></code>
<br /><i>
(type=Jabber ID of the entity to send the request to)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
Callback list for this IQ. Any callbacks added to this list
will be fired when the result comes back.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="callbacks"></a>
<h3>callbacks</h3>
Callback list to be notified when response comes back
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>hemp.utility.CallbackList</code>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:34 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>