Home       Trees       Index       Help   

PyXMPP

Package pyxmpp :: Package jabber :: Module disco :: Class DiscoItem
[show private | hide private]
[frames | no frames]

Type DiscoItem

                object --+    
                         |    
      CachedPropertyObject --+
                             |
                object --+   |
                         |   |
StanzaPayloadWrapperObject --+
                             |
                            DiscoItem


An item of disco#items reply.

:Ivariables:
    - `jid`: the JID of the item (cached).
    - `node`: node name of the item (cached).
    - `name`: name of the item (cached).
    - `action`: action of the item (cached).
    - `disco`: the disco reply this is the part of.
    - `xmlnode`: XML element describing the item.
:Types:
    - `jid`: `JID`
    - `node`: `unicode`
    - `name`: `unicode`
    - `action`: `unicode`
    - `disco`: `DiscoItems`
    - `xmlnode`: `libxml2.xmlNode`
Method Summary
  __init__(self, disco, xmlnode_or_jid, node, name, action)
Initialize an `DiscoItem` object.
  __del__(self)
  __str__(self)
  get_action(self)
Get the action attribute of the item.
  get_jid(self)
Get the JID of the item.
  get_name(self)
Get the name of the item.
  get_node(self)
Get the node of the item.
  remove(self)
Remove `self` from the containing `DiscoItems` object.
  set_action(self, action)
Set the action of the item.
  set_jid(self, jid)
Set the JID of the item.
  set_name(self, name)
Set the name of the item.
  set_node(self, node)
Set the node of the item.
    Inherited from CachedPropertyObject
  __getattr__(self, name)
  __setattr__(self, name, value)
    Inherited from StanzaPayloadWrapperObject
  as_xml(self, parent, doc)
Get the XML representation of `self`.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)

Method Details

__init__(self, disco, xmlnode_or_jid, node=None, name=None, action=None)
(Constructor) 

Initialize an `DiscoItem` object.

:Parameters:
    - `disco`: the disco#items reply `self` is a part of.
    - `xmlnode_or_jid`: XML element describing the item or the JID of
      the item.
    - `node`: disco node of the item.
    - `name`: name of the item.
    - `action`: 'action' attribute of the item.
:Types:
    - `disco`: `DiscoItems`
    - `xmlnode_or_jid`: `libxml2.xmlNode` or `JID`
    - `node`: `unicode`
    - `name`: `unicode`
    - `action`: `unicode`
Overrides:
__builtin__.object.__init__

get_action(self) 

Get the action attribute of the item.

:return: the action of the item or `None`.
:returntype: `unicode`

get_jid(self) 

Get the JID of the item.

:return: the JID of the item.
:returntype: `JID`

get_name(self) 

Get the name of the item.

:return: the name of the item or `None`.
:returntype: `unicode`

get_node(self) 

Get the node of the item.

:return: the node of the item or `None`.
:returntype: `unicode`

remove(self) 

Remove `self` from the containing `DiscoItems` object.

set_action(self, action) 

Set the action of the item.

:Parameters:
    - `action`: the new action or `None`.
:Types:
    - `action`: `unicode`

set_jid(self, jid) 

Set the JID of the item.

:Parameters:
    - `jid`: the new jid.
:Types:
    - `jid`: `JID`

set_name(self, name) 

Set the name of the item.

:Parameters:
    - `name`: the new name or `None`.
:Types:
    - `name`: `unicode`

set_node(self, node) 

Set the node of the item.

:Parameters:
    - `node`: the new node or `None`.
:Types:
    - `node`: `unicode`

   Home       Trees       Index       Help   

PyXMPP

Generated by Epydoc 2.1 on Wed May 31 22:36:58 2006 http://epydoc.sf.net