slidge.plugins.telegram.contact#

Module Contents#

Classes#

Contact

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

Roster

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

Functions#

noop()

Attributes#

log

async slidge.plugins.telegram.contact.noop()[source]#
class slidge.plugins.telegram.contact.Contact(*a, **k)[source]#

Bases: slidge.LegacyContact[slidge.plugins.telegram.session.Session]

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:

Parameters
  • 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

legacy_id :int[source]#
CLIENT_TYPE = phone[source]#
async _expire_online(timestamp)[source]#
Parameters

timestamp (Union[int, float]) –

update_status(status)[source]#
Parameters

status (aiotdlib.api.UserStatus) –

async send_tg_message(msg)[source]#
Parameters

msg (aiotdlib.api.Message) –

async send_tg_file(best_file, caption, msg_id)[source]#
async update_info_from_user(user=None)[source]#
Parameters

user (Optional[aiotdlib.api.User]) –

async update_info_from_chat(chat)[source]#
Parameters

chat (aiotdlib.api.Chat) –

class slidge.plugins.telegram.contact.Roster(session)[source]#

Bases: slidge.LegacyRoster[Contact, slidge.plugins.telegram.session.Session]

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.SessionType) –

static 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

Parameters

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

Returns

An identifier for the user on the legacy network.

Return type

int

slidge.plugins.telegram.contact.log[source]#