<?xml version="1.0" encoding="ascii"?>
<!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>pyxmpp.roster.Roster</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="pyxmpp-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://pyxmpp.jajcus.net/">PyXMPP</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="pyxmpp-module.html">Package pyxmpp</a> ::
<a href="pyxmpp.roster-module.html">Module roster</a> ::
Class Roster
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Roster</h1><p class="nomargin-top"><span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster">source code</a></span></p>
<pre class="base-tree">
object --+
|
<a href="pyxmpp.objects.StanzaPayloadObject-class.html">objects.StanzaPayloadObject</a> --+
|
<strong class="uidshort">Roster</strong>
</pre>
<hr />
<p>Class representing XMPP-IM roster.</p>
<p>Iteration over <a href="pyxmpp.roster.Roster-class.html" class="link">Roster</a> object iterates over roster items.</p>
<p><tt class="rst-docutils literal">for item in roster: ...</tt> may be used to iterate over roster items,
<tt class="rst-docutils literal">roster[jid]</tt> to get roster item by jid, <tt class="rst-docutils literal">jid in roster</tt> to test roster
for jid presence.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxmpp.roster.Roster-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">node</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">server</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">strict</span>=<span class="summary-sig-default">True</span>)</span><br />
Initialize Roster object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxmpp.roster.Roster-class.html#from_xml" class="summary-sig-name">from_xml</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">node</span>,
<span class="summary-sig-arg">strict</span>=<span class="summary-sig-default">True</span>)</span><br />
Initialize Roster object from XML node.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.from_xml">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxmpp.roster.Roster-class.html#complete_xml_element" class="summary-sig-name">complete_xml_element</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">xmlnode</span>,
<span class="summary-sig-arg">doc</span>)</span><br />
Complete the XML node with <code class="link">self</code> content.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.complete_xml_element">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxmpp.roster.Roster-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
str(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.__str__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.__iter__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__contains__"></a><span class="summary-sig-name">__contains__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">jid</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.__contains__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__getitem__"></a><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">jid</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.__getitem__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_items"></a><span class="summary-sig-name">get_items</span>(<span class="summary-sig-arg">self</span>)</span><br />
Return a list of items in the roster.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.get_items">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_groups"></a><span class="summary-sig-name">get_groups</span>(<span class="summary-sig-arg">self</span>)</span><br />
Return a list of groups in the roster.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.get_groups">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxmpp.roster.Roster-class.html#get_items_by_name" class="summary-sig-name">get_items_by_name</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">case_sensitive</span>=<span class="summary-sig-default">True</span>)</span><br />
Return a list of items with given <code class="link">name</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.get_items_by_name">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxmpp.roster.Roster-class.html#get_items_by_group" class="summary-sig-name">get_items_by_group</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">group</span>,
<span class="summary-sig-arg">case_sensitive</span>=<span class="summary-sig-default">True</span>)</span><br />
Return a list of groups with given name.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.get_items_by_group">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxmpp.roster.Roster-class.html#get_item_by_jid" class="summary-sig-name">get_item_by_jid</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">jid</span>)</span><br />
Return roster item with given jid.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.get_item_by_jid">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxmpp.roster.Roster-class.html#add_item" class="summary-sig-name">add_item</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">item_or_jid</span>,
<span class="summary-sig-arg">subscription</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">none</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">groups</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="summary-sig-arg">ask</span>=<span class="summary-sig-default">None</span>)</span><br />
Add an item to the roster.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.add_item">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="remove_item"></a><span class="summary-sig-name">remove_item</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">jid</span>)</span><br />
Remove item from the roster.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.remove_item">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxmpp.roster.Roster-class.html#update" class="summary-sig-name">update</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">query</span>)</span><br />
Apply an update request to the roster.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.update">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyxmpp.objects.StanzaPayloadObject-class.html">objects.StanzaPayloadObject</a></code></b>:
<code><a href="pyxmpp.objects.StanzaPayloadObject-class.html#as_xml">as_xml</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">: <code class="link">unicode</code></span>
</td><td class="summary">
<a name="xml_element_name"></a><span class="summary-name">xml_element_name</span> = <code title="'query'"><code class="variable-quote">'</code><code class="variable-string">query</code><code class="variable-quote">'</code></code><br />
: name for the XML element provided by the class.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">: <code class="link">unicode</code></span>
</td><td class="summary">
<a name="xml_element_namespace"></a><span class="summary-name">xml_element_namespace</span> = <code title="'jabber:iq:roster'"><code class="variable-quote">'</code><code class="variable-string">jabber:iq:roster</code><code class="variable-quote">'</code></code><br />
: namespace URI for the XML element provided
by the class.
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">: <code class="link">dict</code> of <a href="pyxmpp.jid.JID-class.html" class="link">JID</a> -> <a href="pyxmpp.roster.RosterItem-class.html" class="link">RosterItem</a></span>
</td><td class="summary">
<a name="items_dict"></a><span class="summary-name">items_dict</span><br />
: items indexed by JID.
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="pyxmpp.roster.Roster-class.html#items" class="summary-name">items</a><br />
Return a list of items in the roster.
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">node</span>=<span class="sig-default">None</span>,
<span class="sig-arg">server</span>=<span class="sig-default">False</span>,
<span class="sig-arg">strict</span>=<span class="sig-default">True</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.__init__">source code</a></span>
</td>
</tr></table>
<p>Initialize Roster object.</p>
<p><code class="link">node</code> should be an XML representation of the roster (e.g. as sent
from server in response to roster request). When <code class="link">node</code> is None empty
roster will be created.</p>
<p>If <code class="link">server</code> is true the object is considered server-side roster.</p>
<p>If <code class="link">strict</code> is False, than invalid items in the XML will be ignored.</p>
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="from_xml"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">from_xml</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">node</span>,
<span class="sig-arg">strict</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.from_xml">source code</a></span>
</td>
</tr></table>
<p>Initialize Roster object from XML node.</p>
<p>If <code class="link">strict</code> is False, than invalid items in the XML will be ignored.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="complete_xml_element"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">complete_xml_element</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">xmlnode</span>,
<span class="sig-arg">doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.complete_xml_element">source code</a></span>
</td>
</tr></table>
<p>Complete the XML node with <code class="link">self</code> content.</p>
<p>Should be overriden in classes derived from <a href="pyxmpp.objects.StanzaPayloadObject-class.html" class="link">StanzaPayloadObject</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>xmlnode</code></strong> (: <code class="link">libxml2.xmlNode</code>) - : XML node with the element being built. It has already
right name and namespace, but no attributes or content.</li>
<li><strong class="pname"><code>doc</code></strong> (: <code class="link">libxml2.xmlDoc</code>) - : document to which the element belongs.</li>
</ul></dd>
<dt>Overrides:
<a href="pyxmpp.objects.StanzaPayloadObject-class.html#complete_xml_element">objects.StanzaPayloadObject.complete_xml_element</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.__str__">source code</a></span>
</td>
</tr></table>
<p>str(x)</p>
<dl class="fields">
<dt>Overrides:
object.__str__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="get_items_by_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_items_by_name</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">case_sensitive</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.get_items_by_name">source code</a></span>
</td>
</tr></table>
<p>Return a list of items with given <code class="link">name</code>.</p>
<p>If <code class="link">case_sensitive</code> is False the matching will be case insensitive.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="get_items_by_group"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_items_by_group</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">group</span>,
<span class="sig-arg">case_sensitive</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.get_items_by_group">source code</a></span>
</td>
</tr></table>
<p>Return a list of groups with given name.</p>
<p>If <code class="link">case_sensitive</code> is False the matching will be case insensitive.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="get_item_by_jid"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_item_by_jid</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">jid</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.get_item_by_jid">source code</a></span>
</td>
</tr></table>
Return roster item with given jid.
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>KeyError</strong></code> - if the item is not found.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="add_item"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_item</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">item_or_jid</span>,
<span class="sig-arg">subscription</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">none</code><code class="variable-quote">'</code></span>,
<span class="sig-arg">name</span>=<span class="sig-default">None</span>,
<span class="sig-arg">groups</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="sig-arg">ask</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.add_item">source code</a></span>
</td>
</tr></table>
<p>Add an item to the roster.</p>
<p>The <code class="link">item_or_jid</code> argument may be a <a href="pyxmpp.roster.RosterItem-class.html" class="link">RosterItem</a> object or a <a href="pyxmpp.jid.JID-class.html" class="link">JID</a>. If
it is a JID then <code class="link">subscription</code>, <code class="link">name</code>, <code class="link">groups</code> and <code class="link">ask</code> may also be
specified.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="update"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">update</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">query</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxmpp.roster-pysrc.html#Roster.update">source code</a></span>
</td>
</tr></table>
<p>Apply an update request to the roster.</p>
<p><code class="link">query</code> should be a query included in a "roster push" IQ received.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Property Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-PropertyDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="items"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">items</h3>
Return a list of items in the roster.
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="pyxmpp.roster.Roster-class.html#get_items" class="summary-sig-name">get_items</a>(<span class="summary-sig-arg">self</span>)</span>
- Return a list of items in the roster.
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="pyxmpp-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://pyxmpp.jajcus.net/">PyXMPP</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun May 8 13:35:04 2011
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
