sleamdge.contact

Module Contents

Classes

Roster

Virtual roster of a gateway user, that allows to represent all

Contact

This class centralizes actions in relation to a specific legacy contact.
class sleamdge.contact.Roster(session)[source]

Bases: slidge.LegacyRoster[steam.types.id.ID32, Contact]

Virtual roster of a gateway user, that allows to represent all of their contacts as singleton instances (if used properly and not too bugged).

Every BaseSession instance will have its own LegacyRoster instance accessible via the BaseSession.contacts attribute.

Typically, you will mostly use the LegacyRoster.by_legacy_id() function to retrieve a contact instance.

You might need to override LegacyRoster.legacy_id_to_jid_username() and/or LegacyRoster.jid_username_to_legacy_id() to incorporate some custom logic if you need some characters when translation JID user parts and legacy IDs.

Parameters:

session (slidge.core.session.BaseSession)

session: sleamdge.session.Session[source]
async by_steam_user(user)[source]
Parameters:

user (steam.User)

Return type:

Contact

async jid_username_to_legacy_id(local)[source]

Convert a JID user part to a legacy ID.

Should be overridden in case legacy IDs are not strings, or more generally for any case where the username part of a JID (unescaped with to the mapping defined by XEP-0106) is not enough to identify a contact on the legacy network.

Default implementation is an identity operation

Parameters:
Returns:

An identifier for the user on the legacy network.

Return type:

steam.types.id.ID32

async fill()[source]

Populate slidge’s “virtual roster”.

Override this and in it, await self.by_legacy_id(contact_id) for the every legacy contacts of the user for which you’d like to set an avatar, nickname, vcard…

Await Contact.add_to_roster() in here to add the contact to the user’s XMPP roster.

Return type:

None

class sleamdge.contact.Contact(session, legacy_id, jid_username)[source]

Bases: slidge.LegacyContact[steam.types.id.ID32]

This class centralizes actions in relation to a specific legacy contact.

You shouldn’t create instances of contacts manually, but rather rely on LegacyRoster.by_legacy_id() to ensure that contact instances are singletons. The LegacyRoster instance of a session is accessible through the BaseSession.contacts attribute.

Typically, your plugin should have methods hook to the legacy events and call appropriate methods here to transmit the “legacy action” to the xmpp user. This should look like this:

Use carbon=True as a keyword arg for methods to represent an action FROM the user TO the contact, typically when the user uses an official client to do an action such as sending a message or marking as message as read. This will use XEP-0363 to impersonate the XMPP user in order.

Parameters:

  • session (slidge.core.session.BaseSession) – The session this contact is part of

  • legacy_id (slidge.util.types.LegacyUserIdType) – The contact’s legacy ID

  • jid_username (str) – User part of this contact’s ‘puppet’ JID. NB: case-insensitive, and some special characters are not allowed

MARKS = False[source]
CORRECTION = False[source]
RETRACTION = False[source]
session: sleamdge.session.Session[source]
async get_steam_channel()[source]
Return type:

steam.User

async update_info(user=None)[source]

Fetch information about this contact from the legacy network

This is awaited on Contact instantiation, and should be overridden to update the nickname, avatar, vcard […] of this contact, by making “legacy API calls”.

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 .avatar property.

Parameters:

user (Optional[steam.User])

Return type:

None

async update_state(user=None)[source]
Parameters:

user (Optional[steam.User])

Return type:

None

async available_emojis(legacy_msg_id=None)[source]

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]

async update_reaction(reaction)[source]
Parameters:

reaction (steam.MessageReaction)

Return type:

None

async fetch_message(legacy_msg_id)[source]
Parameters:

legacy_msg_id (int)

Return type:

steam.UserMessage