sleamdge.group

Classes

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

Module Contents

class sleamdge.group.Bookmarks(session)

Bases: slidge.LegacyBookmarks[sleamdge.types.ChannelId, slidge.LegacyMUC]

This is instantiated once per BaseSession

Parameters:

session (slidge.core.session.BaseSession)

session: sleamdge.session.Session

async by_steam_channel(channel)

Parameters:

channel (Union[steam.GroupChannel, steam.ClanChannel])

async legacy_id_to_jid_local_part(legacy_id)

Parameters:

legacy_id (sleamdge.types.ChannelId)

Return type:

str

async jid_local_part_to_legacy_id(local_part)

Parameters:

local_part (str)

Return type:

sleamdge.types.ChannelId

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 sleamdge.group.Participant(muc, nickname=None, is_user=False, is_system=False, role='participant', affiliation='member')

Bases: slidge.LegacyParticipant

A legacy participant of a legacy group chat.

Parameters:

• muc (slidge.group.room.LegacyMUC)

• nickname (Optional[str])

• role (slidge.util.types.MucRole)

• affiliation (slidge.util.types.MucAffiliation)

contact: sleamdge.contact.Contact

muc: MUC

session: sleamdge.session.Session

async update_reaction(reaction)

Parameters:

reaction (steam.MessageReaction)

Return type:

None

class sleamdge.group.MUC(session, legacy_id, jid)

Bases: slidge.LegacyMUC[sleamdge.types.ChannelId, int, 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.

Parameters:

• session (slidge.core.session.BaseSession)

• legacy_id (slidge.util.types.LegacyGroupIdType)

• jid (slixmpp.JID)

session: sleamdge.session.Session

async get_steam_channel()

Return type:

Union[steam.GroupChannel, steam.ClanChannel]

async fetch_message(legacy_msg_id)

Parameters:

legacy_msg_id (int)

Return type:

Union[steam.GroupMessage, steam.ClanMessage]

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.

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.

Return type:

AsyncIterator[Participant]

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

async available_emojis(legacy_msg_id=None)

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

Returns:

A set of emojis or None if any emoji is allowed

Return type:

set[str]