Implements interfaces: wokkel.iwokkel.IMUCClient

Multi-User Chat client protocol.

This is a subclass of XMPPHandler and implements IMUCClient.

Method __init__ Undocumented
Method unavailableReceived Unavailable presence was received.
Method availableReceived Available presence was received.
Method groupChatReceived A group chat message has been received from a MUC room.
Method userJoinedRoom User has joined a MUC room.
Method userLeftRoom User has left a room.
Method userUpdatedStatus User Presence has been received.
Method receivedSubject A (new) room subject has been received.
Method receivedGroupChat A groupchat message was received.
Method receivedHistory A groupchat message from the room's discussion history 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 leave Leave a MUC room.
Method status Change user status.
Method destroy Destroy a room.
Instance Variable _rooms Collection of occupied rooms, keyed by the bare JID of the room. Note that a particular entity can only join a room once at a time. (type: dict)
Method _addRoom Add a room to the room collection.
Method _getRoom Grab a room from the room collection.
Method _removeRoom Delete a room from the room collection.
Method _getRoomUser Lookup the room and user associated with the stanza's sender.

Inherited from MUCClientProtocol:

Method connectionInitialized Called when the XML stream has been initialized.
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 _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 (via MUCClientProtocol):

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 MUCClientProtocol, 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.
_rooms =
Collection of occupied rooms, keyed by the bare JID of the room. Note that a particular entity can only join a room once at a time. (type: dict)
def __init__(self, reactor=None): (source)
Undocumented
def _addRoom(self, room): (source)

Add a room to the room collection.

Rooms are stored by the JID of the room itself. I.e. it uses the Room ID and service parts of the Room JID.

NoteAn entity can only join a particular room once.
def _getRoom(self, roomJID): (source)

Grab a room from the room collection.

This uses the Room ID and service parts of the given JID to look up the Room instance associated with it.

def _removeRoom(self, roomJID): (source)

Delete a room from the room collection.

def _getRoomUser(self, stanza): (source)

Lookup the room and user associated with the stanza's sender.

def unavailableReceived(self, presence): (source)

Unavailable presence was received.

If this was received from a MUC room occupant JID, that occupant has left the room.

def availableReceived(self, presence): (source)

Available presence was received.

def groupChatReceived(self, message): (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 userJoinedRoom(self, room, user): (source)

User has joined a MUC room.

This method will need to be modified inorder for clients to do something when this event occurs.

ParametersroomThe room the user has joined. (type: Room)
userThe user that joined the MUC room. (type: User)
def userLeftRoom(self, room, user): (source)

User has left a room.

This method will need to be modified inorder for clients to do something when this event occurs.

ParametersroomThe room the user has joined. (type: Room)
userThe user that left the MUC room. (type: User)
def userUpdatedStatus(self, room, user, show, status): (source)

User Presence has been received.

This method will need to be modified inorder for clients to do something when this event occurs.

def receivedSubject(self, room, user, subject): (source)

A (new) room subject has been received.

This method will need to be modified inorder for clients to do something when this event occurs.

def receivedGroupChat(self, room, user, message): (source)

A groupchat message was received.

ParametersroomThe room the message was received from. (type: Room)
userThe user that sent the message, or None if it was a message from the room itself. (type: User)
messageThe message. (type: GroupChat)
def receivedHistory(self, room, user, message): (source)

A groupchat message from the room's discussion history was received.

This is identical to receivedGroupChat, with the delayed delivery information (timestamp and original sender) in message.delay. For anonymous rooms, message.delay.sender is the room's address.

ParametersroomThe room the message was received from. (type: Room)
userThe user that sent the message, or None if it was a message from the room itself. (type: User)
messageThe message. (type: GroupChat)
def join(self, roomJID, nick, historyOptions=None, password=None): (source)

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 with the room when the entity is in the room, or with a failure if an error has occurred.
def nick(self, roomJID, nick): (source)

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

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

ParametersroomJIDThe JID of the room, i.e. without a resource. (type: JID)
nickThe new nick name within the room. (type: unicode)
def leave(self, roomJID): (source)

Leave a MUC room.

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

ParametersroomJIDThe Room JID of the room to leave. (type: JID)
def status(self, roomJID, show=None, status=None): (source)

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 destroy(self, roomJID, reason=None, alternate=None, password=None): (source)

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.