Module Contents#



A room, a.k.a. a Multi-User Chat.

class, legacy_id, jid)#

A room, a.k.a. a Multi-User Chat.

MUC instances are obtained by calling on the user’s slidge.core.session.BaseSession.

property avatar_id: slidge.util.types.AvatarIdType | None#

The unique ID of this entity’s avatar.

Return type:


property avatar: slidge.util.types.AvatarIdType | None#

This property can be used to set the avatar, but set_avatar() should be preferred because you can provide a unique ID for the avatar for efficient caching. Setting this is OKish in case the avatar type is a URL or a local path that can act as a legacy ID.

Python’s property is abused here to maintain backwards compatibility, but when getting it you actually get the avatar legacy ID.

Return type:



Because legacy events like reactions, editions, etc. don’t all map to a stanza with a proper legacy ID, slidge usually cannot guarantee the stability of the archive across restarts.

Set this to True if you know what you’re doing, but realistically, this can’t be set to True until archive is permanently stored on disk by slidge.

This is just a flag on archive responses that most clients ignore anyway.


Set this to True if the participant list is not full after calling fill_participants(). This is a workaround for networks with huge participant lists which do not map really well the MUCs where all presences are sent on join. It allows to ensure that the participants that last spoke (within the fill_history() method are effectively participants, thus making possible for XMPP clients to fetch their avatars.


Set this to false if the legacy network does not allow setting a description for the group. In this case the description field will not be present in the room configuration form.


Set this to false if the legacy network does not allow setting a subject (sometimes also called topic) for the group. In this case, as a subject is recommended by XEP-0045 (“SHALL”), the description (or the group name as ultimate fallback) will be used as the room subject. By setting this to false, an error will be returned when the User tries to set the room subject.

abstract async update_info()#

Fetch information about this group from the legacy network

This is awaited on MUC instantiation, and should be overridden to update the attributes of the group chat, like title, subject, number of participants etc.

To take advantage of the slidge avatar cache, you can check the .avatar property to retrieve the “legacy file ID” of the cached avatar. If there is no change, you should not call slidge.core.mixins.avatar.AvatarMixin.set_avatar() or attempt to modify the :attr:.avatar property.

abstract async backfill(oldest_message_id=None, oldest_message_date=None)#

Override this if the legacy network provide server-side archive. In it, send history messages using self.get_participant().send*, with the archive_only=True kwarg.

You only need to fetch messages older than oldest_message_id.

  • oldest_message_id (Optional[slidge.util.types.LegacyMessageType]) – The oldest message ID already present in the archive

  • oldest_message_date (Optional[datetime.datetime]) – The oldest message date already present in the archive

abstract async fill_participants()#

In here, call self.get_participant(), self.get_participant_by_contact(), of self.get_user_participant() to make an initial list of participants.

async get_user_participant(**kwargs)#

Get the participant representing the gateway user


kwargs – additional parameters for the Participant construction (optional)


Return type:


async get_participant(nickname, raise_if_not_found=False, fill_first=False, store=True, **kwargs)#

Get a participant by their nickname.

In non-anonymous groups, you probably want to use LegacyMUC.get_participant_by_contact() instead.

  • nickname (str) – Nickname of the participant (used as resource part in the MUC)

  • raise_if_not_found – Raise XMPPError(“item-not-found”) if they are not in the participant list (internal use by slidge, plugins should not need that)

  • fill_first – Ensure LegacyMUC.fill_participants() has been called first (internal use by slidge, plugins should not need that)

  • store – persistently store the user in the list of MUC participants

  • kwargs – additional parameters for the Participant construction (optional)


Return type:



Get a pseudo-participant, representing the room itself

Can be useful for events that cannot be mapped to a participant, e.g. anonymous moderation events, or announces from the legacy service :return:

Return type:


async get_participant_by_contact(c, **kwargs)#

Get a non-anonymous participant.

This is what should be used in non-anonymous groups ideally, to ensure that the Contact jid is associated to this participant


Return type:


async get_participants()#

Get all known participants of the group, ensure LegacyMUC.fill_participants() has been awaited once before. Plugins should not use that, internal slidge use only. :return:

remove_participant(p, kick=False, ban=False)#

Call this when a participant leaves the room

  • p (slidge.util.types.LegacyParticipantType) – The participant

  • kick – Whether the participant left because they were kicked

  • ban – Whether the participant left because they were banned

async kick_resource(r)#

Kick a XMPP client of the user. (slidge internal use)


r (str) – The resource to kick

async add_to_bookmarks(auto_join=True, invite=False, preserve=True)#

Add the MUC to the user’s XMPP bookmarks (:xep:`0402’)

This requires that slidge has the IQ privileged set correctly on the XMPP server

  • auto_join – whether XMPP clients should automatically join this MUC on startup. In theory, XMPP clients will receive a “push” notification when this is called, and they will join if they are online.

  • invite – send an invitation to join this MUC emanating from the gateway. While this should not be strictly necessary, it can help for clients that do not support XEP-0402, or that have ‘do not honor bookmarks auto-join’ turned on in their settings.

  • preserve – preserve auto-join and bookmarks extensions set by the user outside slidge

abstract async on_avatar(data, mime)#

Called when the user tries to set the avatar of the room from an XMPP client.

If the set avatar operation is completed, should return a legacy image unique identifier. In this case the MUC avatar will be immediately updated on the XMPP side.

If data is not None and this method returns None, then we assume that self.set_avatar() will be called elsewhere, eg triggered by a legacy room update event.

  • data (Optional[bytes]) – image data or None if the user meant to remove the avatar

  • mime (Optional[str]) – the mime type of the image. Since this is provided by the XMPP client, there is no guarantee that this is valid or correct.


A unique avatar identifier, which will trigger Alternatively, None, if LegacyMUC.set_avatar() is meant to be awaited somewhere else.

Return type:

Optional[Union[int, str]]

abstract async on_set_affiliation(contact, affiliation, reason, nickname)#

Triggered when the user requests changing the affiliation of a contact for this group,

Examples: promotion them to moderator, kick (affiliation=none), ban (affiliation=outcast).

  • contact ( – The contact whose affiliation change is requested

  • affiliation (slidge.util.types.MucAffiliation) – The new affiliation

  • reason (Optional[str]) – A reason for this affiliation change

  • nickname (Optional[str]) –

abstract async on_set_config(name, description)#

Triggered when the user requests changing the room configuration. Only title and description can be changed at the moment.

The legacy module is responsible for updating title and/or description of this instance.

If HAS_DESCRIPTION is set to False, description will always be None.

  • name (Optional[str]) – The new name of the room.

  • description (Optional[str]) – The new description of the room.

abstract async on_destroy_request(reason)#

Triggered when the user requests room destruction.


reason (Optional[str]) – Optionally, a reason for the destruction

abstract async on_set_subject(subject)#

Triggered when the user requests changing the room subject.

The legacy module is responsible for updating subject of this instance.


subject (str) – The new subject for this room.

Return type:


async set_avatar(a, avatar_unique_id=None, blocking=False, cancel=True)#

Set an avatar for this entity

  • a (Optional[slidge.util.types.AvatarType]) –

  • avatar_unique_id (Optional[slidge.util.types.LegacyFileIdType]) –

  • blocking

  • cancel

Return type:


async available_emojis(legacy_msg_id=None)#

Override this to restrict the subset of reactions this recipient can handle.


A set of emojis or None if any emoji is allowed


legacy_msg_id (Optional[slidge.util.types.LegacyMessageType]) –

Return type: