slidge_whatsapp.contact

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

Module Contents

class slidge_whatsapp.contact.Contact(session, legacy_id, jid_username)

Bases: slidge.LegacyContact[str]

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

CORRECTION = True

REACTIONS_SINGLE_EMOJI = True

async update_presence(presence, last_seen_timestamp)

Parameters:

• presence (slidge_whatsapp.generated.whatsapp.PresenceKind) –

• last_seen_timestamp (int) –

class slidge_whatsapp.contact.Roster(session)

Bases: slidge.LegacyRoster[str, 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: slidge_whatsapp.session.Session

async fill()

Retrieve contacts from remote WhatsApp service, subscribing to their presence and adding to local roster.

async add_whatsapp_contact(data)

Adds a WhatsApp contact to local roster, filling all required and optional information.

Parameters:

data (slidge_whatsapp.generated.whatsapp.Contact) –

Return type:

Contact | None

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.

Parameters:

legacy_id (str) –

Return type:

str

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

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:

str