Known implementations: wokkel.muc.MUCClient

Multi-User Chat Client.

A client interface to XEP-045 : http://xmpp.org/extensions/xep-0045.html

Method receivedSubject The room subject has been received.
Method receivedHistory Past messages from a chat room have been received.
Method configure Configure a room.
Method getConfiguration Grab the configuration from the room.
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 userJoinedRoom User has joined a MUC room.
Method groupChat Send a groupchat message.
Method chat Send a private chat message to a user in a MUC room.
Method register Send a request to register for a room.
Method subject Change the subject of a MUC 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 ban Ban a user from a MUC room.
Method kick Kick a user from a MUC room.
def receivedSubject(room, user, subject): (source)

The room subject has been received.

A subject is received when you join a room and when the subject is changed.

ParametersroomThe room the subject was accepted for. (type: muc.Room)
userThe user that set the subject. (type: muc.User)
subjectThe subject of the given room. (type: unicode)
def receivedHistory(room, user, message): (source)

Past messages from a chat room have been received.

This occurs when you join a room.

def configure(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 getConfiguration(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 join(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 when the entity is in the room or an error has occurred.
def nick(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(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 userJoinedRoom(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 joined. (type: muc.Room)
userThe user that joined the room. (type: muc.User)
def groupChat(roomJID, body): (source)

Send a groupchat message.

def chat(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 register(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 subject(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 voice(roomJID): (source)

Request voice for a moderated room.

ParametersroomJIDThe room jabber/xmpp entity id. (type: JID)
def history(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 Element, and 'timestamp' with the timestamp. (type: list of Element)
def ban(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(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: JID or unicode)
reasonThe reason given for the kick. (type: unicode)
senderThe entity sending the request. (type: JID)
API Documentation for wokkel, generated by pydoctor at 2018-12-06 14:45:46.