messlidger.group

Classes

Bookmarks	This is instantiated once per BaseSession
MUC	A room, a.k.a. a Multi-User Chat.
Participant	A legacy participant of a legacy group chat.

Module Contents

class messlidger.group.Bookmarks(session)

Bases: slidge.LegacyBookmarks[int, MUC]

This is instantiated once per BaseSession

session: messlidger.session.Session

threads

async by_thread(thread)

Parameters:

thread (maufbapi.types.graphql.Thread)

async legacy_id_to_jid_local_part(i)

Parameters:

i (int)

async jid_local_part_to_legacy_id(local_part)

Parameters:

local_part (str)

async fill()

Establish a user’s known groups.

This has to be overridden in plugins with group support and at the minimum, this should await self.by_legacy_id(group_id) for all the groups a user is part of.

Slidge internals will call this on successful BaseSession.login()

class messlidger.group.MUC(*a, **k)

Bases: slidge.LegacyMUC[int, str, Participant, int]

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

MUC instances are obtained by calling slidge.group.bookmarks.LegacyBookmarks() on the user’s slidge.core.session.BaseSession.

session: messlidger.session.Session

type

REACTIONS_SINGLE_EMOJI = True

_ALL_INFO_FILLED_ON_STARTUP = True

thread = None

async get_thread()

async update_info(thread=None)

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.

Parameters:

thread (Optional[maufbapi.types.graphql.Thread])

async fill_participants()

This method should yield the list of all members of this group.

Typically, use participant = self.get_participant(), self.get_participant_by_contact(), of self.get_user_participant(), and update their affiliation, hats, etc. before yielding them.

async backfill(after=None, before=None)

Override this if the legacy network provide server-side group archives.

In it, send history messages using self.get_participant(xxx).send_xxxx, with the archive_only=True kwarg. This is only called once per slidge run for a given group.

Parameters:

• after (Optional[slidge.util.types.HoleBound]) – Fetch messages after this one. If None, it’s up to you to decide how far you want to go in the archive. If it’s not None, it means slidge has some messages in this archive and you should really try to complete it to avoid “holes” in the history of this group.

• before (Optional[slidge.util.types.HoleBound]) – Fetch messages before this one. If None, fetch all messages up to the most recent one

class messlidger.group.Participant(*a, **kw)

Bases: messlidger.util.ChatterMixin, slidge.LegacyParticipant

A legacy participant of a legacy group chat.

property fb_id