Home | Trees | Index | Help |
|
---|
Package pyxmpp :: Module roster :: Class Roster |
|
object
--+ |StanzaPayloadObject
--+ | Roster
Class representing XMPP-IM roster. Iteration over `Roster` object iterates over roster items. :Ivariables: - `items_dict`: items indexed by JID. :Properties: - `items`: roster items. :Types: - `items_dict`: `dict` of `JID` -> `RosterItem` - `items`: `list` of `RosterItem`
Method Summary | |
---|---|
Initialize Roster object. | |
__contains__(self,
jid)
| |
__iter__(self)
| |
__str__(self)
| |
Add an item to the roster. | |
Complete the XML node with `self` content. | |
Initialize Roster object from XML node. | |
Return a list of groups in the roster. | |
Return roster item with given `jid`. | |
Return a list of items in the roster. | |
Return a list of groups with given name. | |
Return a list of items with given `name`. | |
Remove item from the roster. | |
Apply an update request to the roster. | |
Inherited from StanzaPayloadObject | |
Get the XML representation of `self`. | |
Inherited from object | |
x.__delattr__('name') <==> del x.name | |
x.__getattribute__('name') <==> x.name | |
x.__hash__() <==> hash(x) | |
T.__new__(S, ...) -> a new object with type S, a subtype of T | |
helper for pickle | |
helper for pickle | |
x.__repr__() <==> repr(x) | |
x.__setattr__('name', value) <==> x.name = value |
Property Summary | |
---|---|
items |
Class Variable Summary | |
---|---|
str |
xml_element_name = 'query'
|
str |
xml_element_namespace = 'jabber:iq:roster'
|
Method Details |
---|
__init__(self,
node=None,
server=False,
strict=True)
|
add_item(self, item_or_jid, subscription='none', name=None, groups=(), ask=None)Add an item to the roster. The `item_or_jid` argument may be a `RosterItem` object or a `JID`. If it is a JID then `subscription`, `name`, `groups` and `ask` may also be specified. |
complete_xml_element(self, xmlnode, doc)Complete the XML node with `self` content. Should be overriden in classes derived from `StanzaPayloadObject`. :Parameters: - `xmlnode`: XML node with the element being built. It has already right name and namespace, but no attributes or content. - `doc`: document to which the element belongs. :Types: - `xmlnode`: `libxml2.xmlNode` - `doc`: `libxml2.xmlDoc` |
from_xml(self, node, strict=True)Initialize Roster object from XML node. If `strict` is False, than invalid items in the XML will be ignored. |
get_groups(self)Return a list of groups in the roster. |
get_item_by_jid(self, jid)Return roster item with given `jid`. :raise KeyError: if the item is not found. |
get_items(self)Return a list of items in the roster. |
get_items_by_group(self, group, case_sensitive=True)Return a list of groups with given name. If `case_sensitive` is False the matching will be case insensitive. |
get_items_by_name(self, name, case_sensitive=True)Return a list of items with given `name`. If `case_sensitive` is False the matching will be case insensitive. |
remove_item(self, jid)Remove item from the roster. |
update(self, query)Apply an update request to the roster. `query` should be a query included in a "roster push" IQ received. |
Property Details |
---|
items
|
Class Variable Details |
---|
xml_element_name
|
xml_element_namespace
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Wed May 31 22:36:58 2006 | http://epydoc.sf.net |