slidgnal.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 slidgnal.contact.Contact(session, stored)

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)

• stored (slidge.db.models.Contact)

session: slidgnal.session.Session

CORRECTION = True

REACTIONS_SINGLE_EMOJI = True

async update_info(data=None)

Set fields for contact based on data given, or if none was, as retrieved from Signal.

Parameters:

data (slidgnal.generated.signal.Contact | None)

Return type:

None

class slidgnal.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: slidgnal.session.Session

async fill()

Retrieve contacts from Signal backup, subscribing to their presence and adding to local roster.