slidge.plugins.telegram.gateway#

Module Contents#

Classes#

Gateway

Must be subclassed by a plugin to set up various aspects of the XMPP

Functions#

Attributes#

slidge.plugins.telegram.gateway.REGISTRATION_INSTRUCTIONS = Multiline-String[source]#
Show Value
1You can visit https://my.telegram.org/apps to get an API ID and an API HASH
2
3This is the only tested login method, but other methods (password, bot token, 2FA...)
4should work too, in theory at least.
class slidge.plugins.telegram.gateway.Gateway[source]#

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

Must be subclassed by a plugin to set up various aspects of the XMPP component behaviour, such as its display name or its registration process.

On slidge launch, a singleton is instantiated, and it will be made available to public classes such LegacyContact or BaseSession as the .xmpp attribute. Since it inherits from slixmpp.componentxmpp.ComponentXMPP, this gives you a hand on low-level XMPP interactions via slixmpp plugins, e.g.:

self.send_presence(
    pfrom="somebody@component.example.com",
    pto="someonwelse@anotherexample.com",
)

However, you should not need to do so often since the classes of the plugin API provides higher level abstractions around most commonly needed use-cases, such as sending messages, or displaying a custom status.

REGISTRATION_INSTRUCTIONS[source]#
REGISTRATION_FIELDS[source]#
REGISTRATION_MULTISTEP = True[source]#
ROSTER_GROUP = Telegram[source]#
COMPONENT_NAME = Telegram (slidge)[source]#
COMPONENT_TYPE = telegram[source]#
COMPONENT_AVATAR = https://web.telegram.org/img/logo_share.png[source]#
SEARCH_FIELDS[source]#
async validate(user_jid, registration_form)[source]#

Validate a registration form from a user.

Since XEP-0077 is pretty limited in terms of validation, it is OK to validate anything that looks good here and continue the legacy auth process via direct messages to the user (using BaseGateway.input() for instance)

Parameters
async unregister(user)[source]#

Optionally override this if you need to clean additional stuff after a user has been removed from the permanent user_store.

Parameters

user

Returns

add_adhoc_commands()[source]#

Override this if you want to provide custom adhoc commands (XEP-0050) for your plugin, using slixmpp.plugins.xep_0050.XEP_0050

Basic example:

async adhoc_active_sessions1(iq, adhoc_session)[source]#
Parameters
  • iq (slixmpp.Iq) –

  • adhoc_session (dict[str, Any]) –

async adhoc_active_sessions2(form, adhoc_session)[source]#
Parameters

adhoc_session (dict[str, Any]) –

async adhoc_active_sessions3(form, adhoc_session)[source]#
Parameters

adhoc_session (dict[str, Any]) –

slidge.plugins.telegram.gateway.fmt_tg_session(s)[source]#
Parameters

s (aiotdlib.api.Session) –

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