Known subclasses: wokkel.muc.MUCClient

Multi-User Chat client protocol.

Method __init__ Undocumented
Method connectionInitialized Called when the XML stream has been initialized.
Method groupChatReceived Called when a groupchat message was received.
Method join Join a MUC room by sending presence to it.
Method nick Change an entity's nick name in a MUC room.
Method status Change user status.
Method leave Leave a MUC room.
Method groupChat Send a groupchat message.
Method chat Send a private chat message to a user in a MUC room.
Method subject Change the subject of a MUC room.
Method invite Invite a xmpp entity to a MUC room.
Method getRegisterForm Grab the registration form for a MUC room.
Method register Send a request to register for a room.
Method voice Request voice for a moderated room.
Method history Send history to create a MUC based on a one on one chat.
Method getConfiguration Grab the configuration from the room.
Method configure Configure a room.
Method getMemberList Get the member list of a room.
Method getAdminList Get the admin list of a room.
Method getBanList Get an outcast list from a room.
Method getOwnerList Get an owner list from a room.
Method getModeratorList Get the moderator list of a room.
Method modifyAffiliationList Modify an affiliation list.
Method grantVoice Grant voice to an entity.
Method revokeVoice Revoke voice from a participant.
Method grantModerator Grant moderator privileges to a MUC room.
Method ban Ban a user from a MUC room.
Method kick Kick a user from a MUC room.
Method destroy Destroy a room.
Method _onGroupChat A group chat message has been received from a MUC room.
Method _sendDeferred Send presence stanza, adding a deferred with a timeout.
Method _getAffiliationList Send a request for an affiliation list in a room.
Method _getRoleList Send a request for a role list in a room.
Method _setAffiliation Send a request to change an entity's affiliation to a MUC room.
Method _setRole Send a request to change an occupant's role in a MUC room.

Inherited from BasePresenceProtocol:

Class Variable presenceTypeParserMap Maps presence stanza types to their respective stanza parser classes (derived from Stanza). (type: dict)
Method _onPresence Called when a presence stanza has been received.

Inherited from XMPPHandler (via BasePresenceProtocol):

Method setHandlerParent Set the parent of the handler.
Method disownHandlerParent Remove the parent of the handler.
Method makeConnection A connection over the underlying transport of the XML stream has been established.
Method connectionMade Called after a connection has been established.
Method connectionLost The XML stream has been closed.
Method send Send data over the managed XML stream.
Method request Send an IQ request and track the response.
def __init__(self, reactor=None): (source)
def connectionInitialized(self): (source)

Called when the XML stream has been initialized.

It initializes several XPath events to handle MUC stanzas that come in.

def _onGroupChat(self, element): (source)

A group chat message has been received from a MUC room.

There are a few event methods that may get called here. receivedGroupChat, receivedSubject or receivedHistory.

def groupChatReceived(self, message): (source)
overridden in wokkel.muc.MUCClient

Called when a groupchat message was received.

This method is called with a parsed representation of a received groupchat message and can be overridden for further processing.

For regular groupchat message, the body attribute contains the message body. Conversation history sent by the room upon joining, will have the delay attribute set, room subject changes the subject attribute. See GroupChat for details.

ParametersmessageGroupchat message. (type: GroupChat)
def _sendDeferred(self, stanza): (source)

Send presence stanza, adding a deferred with a timeout.

ParametersstanzaThe presence stanza to send over the wire. (type: generic.Stanza)
timeoutThe number of seconds to wait before the deferred is timed out. (type: int

The deferred object defer.Deferred is returned.

)
def join(self, roomJID, nick, historyOptions=None, password=None): (source)
overridden in wokkel.muc.MUCClient

Join a MUC room by sending presence to it.

ParametersroomJIDThe JID of the room the entity is joining. (type: JID)
nickThe nick name for the entitity joining the room. (type: unicode)
historyOptionsOptions for conversation history sent by the room upon joining. (type: HistoryOptions)
passwordOptional password for the room. (type: unicode)
ReturnsA deferred that fires when the entity is in the room or an error has occurred.
def nick(self, roomJID, nick): (source)
overridden in wokkel.muc.MUCClient

Change an entity's nick name in a MUC room.

See: http://xmpp.org/extensions/xep-0045.html#changenick

ParametersroomJIDThe JID of the room. (type: JID)
nickThe new nick name within the room. (type: unicode)
def status(self, roomJID, show=None, status=None): (source)
overridden in wokkel.muc.MUCClient

Change user status.

See: http://xmpp.org/extensions/xep-0045.html#changepres

ParametersroomJIDThe Room JID of the room. (type: JID)
showThe availability of the entity. Common values are xa, available, etc (type: unicode)
statusThe current status of the entity. (type: unicode)
def leave(self, roomJID): (source)
overridden in wokkel.muc.MUCClient

Leave a MUC room.

See: http://xmpp.org/extensions/xep-0045.html#exit

ParametersroomJIDThe JID of the room. (type: JID)
def groupChat(self, roomJID, body): (source)

Send a groupchat message.

def chat(self, occupantJID, body): (source)

Send a private chat message to a user in a MUC room.

See: http://xmpp.org/extensions/xep-0045.html#privatemessage

ParametersoccupantJIDThe Room JID of the other user. (type: JID)
def subject(self, roomJID, subject): (source)

Change the subject of a MUC room.

See: http://xmpp.org/extensions/xep-0045.html#subject-mod

ParametersroomJIDThe bare JID of the room. (type: JID)
subjectThe subject you want to set. (type: unicode)
def invite(self, roomJID, invitee, reason=None): (source)

Invite a xmpp entity to a MUC room.

See: http://xmpp.org/extensions/xep-0045.html#invite

ParametersroomJIDThe bare JID of the room. (type: JID)
inviteeThe entity that is being invited. (type: JID)
reasonThe reason for the invite. (type: unicode)
def getRegisterForm(self, roomJID): (source)

Grab the registration form for a MUC room.

ParametersroomThe room jabber/xmpp entity id for the requested registration form. (type: JID)
def register(self, roomJID, options): (source)

Send a request to register for a room.

ParametersroomJIDThe bare JID of the room. (type: JID)
optionsA mapping of field names to values, or None to cancel. (type: dict)
def voice(self, roomJID): (source)

Request voice for a moderated room.

ParametersroomJIDThe room jabber/xmpp entity id. (type: JID)
def history(self, roomJID, messages): (source)

Send history to create a MUC based on a one on one chat.

See: http://xmpp.org/extensions/xep-0045.html#continue

ParametersroomJIDThe room jabber/xmpp entity id. (type: JID)
messagesThe history to send to the room as an ordered list of message, represented by a dictionary with the keys 'stanza', holding the original stanza a domish.Element, and 'timestamp' with the timestamp. (type: list of domish.Element)
def getConfiguration(self, roomJID): (source)

Grab the configuration from the room.

This sends an iq request to the room.

ParametersroomJIDThe bare JID of the room. (type: JID)
ReturnsA deferred that fires with the room's configuration form as a data_form.Form or None if there are no configuration options available.
def configure(self, roomJID, options): (source)

Configure a room.

ParametersroomJIDThe room to configure. (type: JID)
optionsA mapping of field names to values, or None to cancel. (type: dict)
def _getAffiliationList(self, roomJID, affiliation): (source)

Send a request for an affiliation list in a room.

def _getRoleList(self, roomJID, role): (source)

Send a request for a role list in a room.

def getMemberList(self, roomJID): (source)

Get the member list of a room.

ParametersroomJIDThe bare JID of the room. (type: JID)
def getAdminList(self, roomJID): (source)

Get the admin list of a room.

ParametersroomJIDThe bare JID of the room. (type: JID)
def getBanList(self, roomJID): (source)

Get an outcast list from a room.

ParametersroomJIDThe bare JID of the room. (type: JID)
def getOwnerList(self, roomJID): (source)

Get an owner list from a room.

ParametersroomJIDThe bare JID of the room. (type: JID)
def getModeratorList(self, roomJID): (source)

Get the moderator list of a room.

ParametersroomJIDThe bare JID of the room. (type: JID)
def _setAffiliation(self, roomJID, entity, affiliation, reason=None, sender=None): (source)

Send a request to change an entity's affiliation to a MUC room.

def _setRole(self, roomJID, nick, role, reason=None, sender=None): (source)

Send a request to change an occupant's role in a MUC room.

def modifyAffiliationList(self, roomJID, entities, affiliation, sender=None): (source)

Modify an affiliation list.

ParametersroomJIDThe bare JID of the room. (type: JID)
entitiesThe list of entities to change for a room. (type: list of JID)
affiliationThe affilation to the entities will acquire. (type: unicode)
senderThe entity sending the request. (type: JID)
def grantVoice(self, roomJID, nick, reason=None, sender=None): (source)

Grant voice to an entity.

ParametersroomJIDThe bare JID of the room. (type: JID)
nickThe nick name for the user in this room. (type: unicode)
reasonThe reason for granting voice to the entity. (type: unicode)
senderThe entity sending the request. (type: JID)
def revokeVoice(self, roomJID, nick, reason=None, sender=None): (source)

Revoke voice from a participant.

This will disallow the entity to send messages to a moderated room.

ParametersroomJIDThe bare JID of the room. (type: JID)
nickThe nick name for the user in this room. (type: unicode)
reasonThe reason for revoking voice from the entity. (type: unicode)
senderThe entity sending the request. (type: JID)
def grantModerator(self, roomJID, nick, reason=None, sender=None): (source)

Grant moderator privileges to a MUC room.

ParametersroomJIDThe bare JID of the room. (type: JID)
nickThe nick name for the user in this room. (type: unicode)
reasonThe reason for granting moderation to the entity. (type: unicode)
senderThe entity sending the request. (type: JID)
def ban(self, roomJID, entity, reason=None, sender=None): (source)

Ban a user from a MUC room.

ParametersroomJIDThe bare JID of the room. (type: JID)
entityThe bare JID of the entity to be banned. (type: JID)
reasonThe reason for banning the entity. (type: unicode)
senderThe entity sending the request. (type: JID)
def kick(self, roomJID, nick, reason=None, sender=None): (source)

Kick a user from a MUC room.

ParametersroomJIDThe bare JID of the room. (type: JID)
nickThe occupant to be banned. (type: unicode)
reasonThe reason given for the kick. (type: unicode)
senderThe entity sending the request. (type: JID)
def destroy(self, roomJID, reason=None, alternate=None, password=None): (source)
overridden in wokkel.muc.MUCClient

Destroy a room.

ParametersroomJIDThe JID of the room. (type: JID)
reasonThe reason for the destruction of the room. (type: unicode)
alternateThe JID of the room suggested as an alternate venue. (type: JID)
API Documentation for wokkel, generated by pydoctor at 2018-12-06 14:45:46.