Package Contents#



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


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

class, legacy_id, jid_username)[source]#

Bases: Generic[slidge.util.types.LegacyUserIdType], slidge.core.mixins.FullCarbonMixin, slidge.core.mixins.recipient.ReactionRecipientMixin, slidge.core.mixins.recipient.ThreadRecipientMixin

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.

  • 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

property name#

Friendly name of the contact, as it should appear in the user’s roster

property avatar#

An image that represents this contact

session: slidge.core.session.BaseSession#
RESOURCE: str = 'slidge'#

A full JID, including a resource part is required for chat states (and maybe other stuff) to work properly. This is the name of the resource the contacts will use.

mtype = 'chat'#
_can_send_carbon = True#
is_group = False#

Return repr(self).

_send(stanza, carbon=False, **send_kwargs)#

stanza (Union[slixmpp.Message, slixmpp.Presence]) –


Return XMPP msg ids sent by this contact up to a given XMPP msg id.

Plugins have no reason to use this, but it is used by slidge core for legacy networks that need to mark all messages as read (most XMPP clients only send a read marker for the latest message).

This has side effects, if the horizon XMPP id is found, messages up to this horizon are not cleared, to avoid sending the same read mark twice.


horizon_xmpp_id (str) – The latest message


A list of XMPP ids or None if horizon_xmpp_id was not found

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

Set the avatar for this contact

  • a (Optional[slidge.util.types.AvatarType]) – Any avatar format supported by slidge

  • avatar_unique_id (Optional[Union[int, str]]) – If possible, provide a unique ID to cache the avatar. If it is not provided, the SHA-1 of the avatar will be used, unless it is an HTTP url. In this case, the url will be used, along with etag or last modified HTTP headers, to avoid fetching uselessly. Beware of legacy plugin where URLs are not stable.

  • blocking – if True, will await setting the avatar, if False, launch in a task


set_vcard(/, full_name = None, given = None, surname = None, birthday = None, phone = None, phones = (), note = None, url = None, email = None, country = None, locality=None)#
  • full_name (Optional[str]) –

  • given (Optional[str]) –

  • surname (Optional[]) –

  • birthday (Optional[str]) –

  • phone (Iterable[str]) –

  • phones (Optional[str]) –

  • note (Optional[str]) –

  • url (Optional[str]) –

  • email (Optional[str]) –

  • country (Optional[str]) –

async add_to_roster()#

Add this contact to the user roster using XEP-0356

async __broadcast_pubsub_items()#
async _set_roster(**kw)#
async on_added_to_roster_no_privilege()#

Send an “unsubscribe”, “unsubscribed”, “unavailable” presence sequence from this contact to the user, ie, “this contact has removed you from their ‘friends’”.

async update_info()#

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”.

async fetch_vcard()#

It the legacy network doesn’t like that you fetch too many profiles on startup, it’s also possible to fetch it here, which will be called when XMPP clients of the user request the vcard, if it hasn’t been fetched before :return:


Bases: Generic[slidge.util.types.LegacyUserIdType, slidge.util.types.LegacyContactType], slidge.core.mixins.lock.NamedLockMixin

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.


session (slidge.core.session.BaseSession) –


Return repr(self).

async __finish_init_contact(legacy_id, jid_username, *args, **kwargs)#
  • legacy_id (slidge.util.types.LegacyUserIdType) –

  • jid_username (str) –

async by_jid(contact_jid)#

Retrieve a contact by their JID

If the contact was not instantiated before, it will be created using slidge.LegacyRoster.jid_username_to_legacy_id() to infer their legacy user ID.


contact_jid (slixmpp.JID) –


Return type:


async by_legacy_id(legacy_id, *args, **kwargs)#

Retrieve a contact by their legacy_id

If the contact was not instantiated before, it will be created using slidge.LegacyRoster.legacy_id_to_jid_username() to infer their legacy user ID.

  • legacy_id (slidge.util.types.LegacyUserIdType) –

  • args – arbitrary additional positional arguments passed to the contact constructor. Requires subclassing LegacyContact.__init__ to accept those. This is useful for networks where you fetch the contact list and information about these contacts in a single request

  • kwargs – arbitrary keyword arguments passed to the contact constructor


Return type:


async by_stanza(s)#

Retrieve a contact by the destination of a stanza

See slidge.Roster.by_legacy_id() for more info.




Return type:

async legacy_id_to_jid_username(legacy_id)#

Convert a legacy ID to a valid ‘user’ part of a JID

Should be overridden for cases where the str conversion of the legacy_id is not enough, e.g., if it is case-sensitive or contains forbidden characters not covered by XEP-0106.


legacy_id (slidge.util.types.LegacyUserIdType) –

Return type:


async jid_username_to_legacy_id(jid_username)#

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


jid_username (str) – User part of a JID, ie “user” in “


An identifier for the user on the legacy network.

Return type:


async fill()#

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.