Home       Trees       Index       Help   

PyXMPP

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

Class MucIq

  Stanza --+    
           |    
          Iq --+
               |
MucStanzaExt --+
               |
              MucIq


Extend `Iq` with MUC related interface.
Method Summary
  __init__(self, xmlnode, from_jid, to_jid, stanza_type, stanza_id, error, error_cond)
Initialize an `Iq` object.
  copy(self)
Return a copy of `self`.
  free(self)
Free the data associated with this `MucIq` object.
  make_kick_request(self, nick, reason)
Make the iq stanza a MUC room participant kick request.
    Inherited from Iq
  get_query(self)
Get the payload element of the stanza.
  get_query_ns(self)
Get a namespace of the stanza payload.
  make_error_response(self, cond)
Create error response for the a "get" or "set" iq stanza.
  make_result_response(self)
Create result response for the a "get" or "set" iq stanza.
  new_query(self, ns_uri, name)
Create new payload element for the stanza.
    Inherited from Stanza
  __del__(self)
  __eq__(self, other)
  __ne__(self, other)
  add_content(self, content)
Add an XML node to the stanza's payload.
  add_new_content(self, ns_uri, name)
Add a new XML element to the stanza payload.
  get_error(self)
Get stanza error information.
  get_from(self)
Get "from" attribute of the stanza.
  get_from_jid(self)
Get "from" attribute of the stanza.
  get_id(self)
Get "id" attribute of the stanza.
  get_node(self)
Return the XML node wrapped into `self`.
  get_stanza_id(self)
Get "id" attribute of the stanza.
  get_stanza_type(self)
Get "type" attribute of the stanza.
  get_to(self)
Get "to" attribute of the stanza.
  get_to_jid(self)
Get "to" attribute of the stanza.
  get_type(self)
Get "type" attribute of the stanza.
  serialize(self)
Serialize the stanza into an UTF-8 encoded XML string.
  set_content(self, content)
Set stanza content to an XML node.
  set_from(self, from_jid)
Set "from" attribute of the stanza.
  set_id(self, stanza_id)
Set "id" attribute of the stanza.
  set_new_content(self, ns_uri, name)
Set stanza payload to a new XML element.
  set_to(self, to_jid)
Set "to" attribute of the stanza.
  set_type(self, stanza_type)
Set "type" attribute of the stanza.
  xpath_eval(self, expr, namespaces)
Evaluate an XPath expression on the stanza XML node.
    Inherited from MucStanzaExt
  clear_muc_child(self)
Remove the MUC specific stanza payload element.
  get_muc_child(self)
Get the MUC specific payload element.
  make_muc_admin_quey(self)
Create <query xmlns="...muc#admin"/> element in the stanza.
  make_muc_userinfo(self)
Create <x xmlns="...muc#user"/> element in the stanza.
  muc_free(self)
Free MUC specific data.

Class Variable Summary
    Inherited from Iq
str stanza_type = 'iq'

Method Details

__init__(self, xmlnode=None, from_jid=None, to_jid=None, stanza_type=None, stanza_id=None, error=None, error_cond=None)
(Constructor) 

Initialize an `Iq` object.

:Parameters:
    - `xmlnode`: XML node to_jid be wrapped into the `Iq` object
      or other Iq object to be copied. If not given then new
      presence stanza is created using following parameters.
    - `from_jid`: sender JID.
    - `to_jid`: recipient JID.
    - `stanza_type`: staza type: one of: "get", "set", "result" or "error".
    - `stanza_id`: stanza id -- value of stanza's "id" attribute. If not
      given, then unique for the session value is generated.
    - `error_cond`: error condition name. Ignored if `stanza_type` is not "error".
:Types:
    - `xmlnode`: `unicode` or `libxml2.xmlNode` or `Iq`
    - `from_jid`: `JID`
    - `to_jid`: `JID`
    - `stanza_type`: `unicode`
    - `stanza_id`: `unicode`
    - `error_cond`: `unicode`
Overrides:
pyxmpp.iq.Iq.__init__

copy(self) 

Return a copy of `self`.
Overrides:
pyxmpp.iq.Iq.copy

free(self) 

Free the data associated with this `MucIq` object.
Overrides:
pyxmpp.stanza.Stanza.free

make_kick_request(self, nick, reason) 

Make the iq stanza a MUC room participant kick request.

:Parameters:
    - `nick`: nickname of user to kick.
    - `reason`: reason of the kick.
:Types:
    - `nick`: `unicode`
    - `reason`: `unicode`

:return: object describing the kick request details.
:returntype: `MucItem`

   Home       Trees       Index       Help   

PyXMPP

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