- class slidge.plugins.telegram.contact.Contact(*a, **k)[source]#
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
LegacyRosterinstance of a session is accessible through the
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:
carbon=Trueas 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 – The session this contact is part of
legacy_id – The contact’s legacy ID
jid_username – User part of this contact’s ‘puppet’ JID. NB: case-insensitive, and some special characters are not allowed
- 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”.
user (Optional[aiotdlib.api.User]) –
- class slidge.plugins.telegram.contact.Roster(session)[source]#
Virtual roster of a gateway user, that allows to represent all of their contacts as singleton instances (if used properly and not too bugged).
BaseSessioninstance will have its own
LegacyRosterinstance accessible via the
Typically, you will mostly use the
LegacyRoster.by_legacy_id()function to retrieve a contact instance.
You might need to override
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) –
- async jid_username_to_legacy_id(jid_username)[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
jid_username (str) – User part of a JID, ie “user” in “firstname.lastname@example.org”
An identifier for the user on the legacy network.
- Return type:
- 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…
Contact.add_to_roster()in here to add the contact to the user’s XMPP roster.