slidge.plugins.mattermost.contact

Module Contents

Classes

Contact	This class centralizes actions in relation to a specific legacy contact.
Attachment	A file attachment to a message
Roster	Virtual roster of a gateway user, that allows to represent all

Functions

unset_to_none(x)

Attributes

T

class slidge.plugins.mattermost.contact.Contact(*a, **kw)

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 – 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

session: slidge.plugins.mattermost.session.Session

MARKS = False

REPLIES = False

async fetch_status()

async update_status(status=None, custom_status=None)

Parameters:

• status (Optional[str]) –

• custom_status (Optional[mattermost_api_reference_client.models.UpdateUserCustomStatusJsonBody]) –

async direct_channel_id()

async mm_id()

async update_reactions(legacy_msg_id)

async update_info(user=None)

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

Parameters:

user (Optional[mattermost_api_reference_client.models.User]) –

async send_mm_post(post, carbon=False)

Parameters:

post (mattermost_api_reference_client.models.Post) –

slidge.plugins.mattermost.contact.T

slidge.plugins.mattermost.contact.unset_to_none(x)

Parameters:

x (Union[T, mattermost_api_reference_client.types.Unset]) –

Return type:

Union[T, None]

class slidge.plugins.mattermost.contact.Attachment

Bases: slidge.util.types.LegacyAttachment

A file attachment to a message

At the minimum, one of the path, steam, data or url attribute has to be set

To be used with LegacyContact.send_files() or LegacyParticipant.send_files()

static from_mm(info, data)

Parameters:

• info (mattermost_api_reference_client.models.FileInfo) –

• data (bytes) –

class slidge.plugins.mattermost.contact.Roster(*a, **kw)

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.

session: slidge.plugins.mattermost.session.Session

user_id_to_username: dict[str, str]

direct_channel_id_to_username: dict[str, str]

STATUS_POLL_INTERVAL = 300

async by_jid(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.

Parameters:

contact_jid –

Returns:

async by_legacy_id(legacy_id, *_a, **_kw)

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.

Parameters:

• legacy_id (str) –

• 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

Returns:

async update_statuses()

async by_mm_user_id(user_id)

Parameters:

user_id (str) –

async by_direct_channel_id(channel_id)

Parameters:

channel_id (str) –

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.