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.
Method Summary
  __init__(self, disco, xmlnode_or_jid, node, name, action)
Initialize an DiscoItem object.
  __del__(self)
  __str__(self)
unicode get_action(self)
Get the action attribute of the item.
JID get_jid(self)
Get the JID of the item.
unicode get_name(self)
Get the name of the item.
unicode 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
libxml2.xmlNode or libxml2.xmlDoc 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)

Instance Variable Summary
unicode action: action of the item (cached).
DiscoItems disco: the disco reply this is the part of.
JID jid: the JID of the item (cached).
unicode name: name of the item (cached).
unicode node: node name of the item (cached).
libxml2.xmlNode xmlnode: XML element describing the item.

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.
           (type=DiscoItems)
xmlnode_or_jid - XML element describing the item or the JID of the item.
           (type=libxml2.xmlNode or JID)
node - disco node of the item.
           (type=unicode)
name - name of the item.
           (type=unicode)
action - 'action' attribute of the item.
           (type=unicode)
Overrides:
__builtin__.object.__init__

get_action(self)

Get the action attribute of the item.
Returns:
the action of the item or None.
           (type=unicode)

get_jid(self)

Get the JID of the item.
Returns:
the JID of the item.
           (type=JID)

get_name(self)

Get the name of the item.
Returns:
the name of the item or None.
           (type=unicode)

get_node(self)

Get the node of the item.
Returns:
the node of the item or None.
           (type=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.
           (type=unicode)

set_jid(self, jid)

Set the JID of the item.
Parameters:
jid - the new jid.
           (type=JID)

set_name(self, name)

Set the name of the item.
Parameters:
name - the new name or None.
           (type=unicode)

set_node(self, node)

Set the node of the item.
Parameters:
node - the new node or None.
           (type=unicode)

Instance Variable Details

action

action of the item (cached).
Type:
unicode

disco

the disco reply this is the part of.
Type:
DiscoItems

jid

the JID of the item (cached).
Type:
JID

name

name of the item (cached).
Type:
unicode

node

node name of the item (cached).
Type:
unicode

xmlnode

XML element describing the item.
Type:
libxml2.xmlNode