Home       Trees       Index       Help   

PyXMPP

Package pyxmpp :: Package jabber :: Module muccore :: Class MucX
[show private | hide private]
[frames | no frames]

Type MucX

                object --+        
                         |        
StanzaPayloadWrapperObject --+    
                             |    
                      MucXBase --+
                                 |
                                MucX


Wrapper for http://www.jabber.org/protocol/muc namespaced
stanza payload "x" elements.
Method Summary
  __init__(self, xmlnode, copy, parent)
Copy MucXBase object or create a new one, possibly based on or wrapping an XML node.
  get_history(self)
Return history parameters carried by the stanza.
  get_password(self)
Get password from the MUC request.
  set_history(self, parameters)
Set history parameters.
  set_password(self, password)
Set password for the MUC request.
    Inherited from MucXBase
  __del__(self)
  free(self)
Unlink and free the XML node owned by `self`.
  free_borrowed(self)
Detach the XML node borrowed by `self`.
  serialize(self)
Serialize `self` as XML.
  xpath_eval(self, expr)
Evaluate XPath expression in context of `self.xmlnode`.
    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)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
str ns = 'http://jabber.org/protocol/muc'
    Inherited from MucXBase
str element = 'x'

Method Details

__init__(self, xmlnode=None, copy=True, parent=None)
(Constructor) 

Copy MucXBase object or create a new one, possibly
based on or wrapping an XML node.

:Parameters:
    - `xmlnode`: is the object to copy or an XML node to wrap.
    - `copy`: when `True` a copy of the XML node provided will be included
      in `self`, the node will be copied otherwise.
    - `parent`: parent node for the created/copied XML element.
:Types:
    - `xmlnode`: `MucXBase` or `libxml2.xmlNode`
    - `copy`: `bool`
    - `parent`: `libxml2.xmlNode`
Overrides:
pyxmpp.jabber.muccore.MucXBase.__init__ (inherited documentation)

get_history(self) 

Return history parameters carried by the stanza.

:returntype: `HistoryParameters`

get_password(self) 

Get password from the MUC request.

:returntype: `unicode`

set_history(self, parameters) 

Set history parameters.

Types:
    - `parameters`: `HistoryParameters`

set_password(self, password) 

Set password for the MUC request.

:Parameters:
    - `password`: password
:Types:
    - `password`: `unicode`

Class Variable Details

ns

Type:
str
Value:
'http://jabber.org/protocol/muc'

   Home       Trees       Index       Help   

PyXMPP

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