Package pyxmpp :: Package jabber :: Module muccore :: Class MucIq

[hide private]

# Class MucIq

source code

    stanza.Stanza --+
                    |
                iq.Iq --+
                        |
         MucStanzaExt --+
                        |
                       MucIq

Extend Iq with MUC related interface.

Instance Methods | [hide private]

__init__(self, xmlnode=None, from_jid=None, to_jid=None, stanza_type=None, stanza_id=None, error=None, error_cond=None) Initialize an Iq object. | source code

Iq

copy(self) Return a copy of `self`. | source code

MucItem

make_kick_request(self, nick, reason) Make the iq stanza a MUC room participant kick request. | source code

free(self) Free the data associated with this MucIq object. | source code

Inherited from `iq.Iq`: `get_query`, `get_query_ns`, `make_error_response`, `make_result_response`, `new_query`

Inherited from `stanza.Stanza`: `__del__`, `__eq__`, `__ne__`, `add_content`, `add_new_content`, `get_error`, `get_from`, `get_from_jid`, `get_id`, `get_node`, `get_stanza_id`, `get_stanza_type`, `get_to`, `get_to_jid`, `get_type`, `serialize`, `set_content`, `set_from`, `set_id`, `set_new_content`, `set_to`, `set_type`, `xpath_eval`

Inherited from `MucStanzaExt`: `clear_muc_child`, `get_muc_child`, `make_muc_admin_quey`, `make_muc_userinfo`, `muc_free`

Class Variables | [hide private]

Inherited from `iq.Iq`: `stanza_type`

Instance Variables | [hide private]

Inherited from `stanza.Stanza`: `stream`, `xmlnode` Inherited from `stanza.Stanza` (private): `_error`

Method Details | [hide private]

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

source code

Initialize an Iq object.

Parameters:
  - `xmlnode` (`unicode` or `libxml2.xmlNode` or Iq) - 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` (JID) - sender JID.
  - `to_jid` (JID) - recipient JID.
  - `stanza_type` (`unicode`) - staza type: one of: "get", "set", "result" or "error".
  - `stanza_id` (`unicode`) - stanza id -- value of stanza's "id" attribute. If not given, then unique for the session value is generated.
  - `error_cond` (`unicode`) - error condition name. Ignored if stanza_type is not "error".
Overrides: MucStanzaExt.__init__

### copy(self)

source code

Return a copy of `self`.

Returns: Iq
Overrides: stanza.Stanza.copy

### make_kick_request(self, nick, reason)

source code

Make the iq stanza a MUC room participant kick request.

Parameters:
  - `nick` (`unicode`) - nickname of user to kick.
  - `reason` (`unicode`) - reason of the kick.
Returns: MucItem
  object describing the kick request details.

### free(self)

source code

Free the data associated with this MucIq object.

Overrides: stanza.Stanza.free