Documentation
Tutorials
Appservice (bridge) usage Bot usage Encryption Room upgrades

Class

PantalaimonClient

PantalaimonClient(homeserverUrl, storageProvider)

Supporting functions for interacting with a Pantalaimon instance.
Constructor

# new PantalaimonClient(homeserverUrl, storageProvider)

Creates a new PantalaimonClient class for interacting with Pantalaimon. The storage provider given will also be used in the client.
Parameters:
Name Type Description
homeserverUrl string The homeserver (Pantalaimon) URL to interact with.
storageProvider IStorageProvider The storage provider to back the client with.

View Source PantalaimonClient.ts, line 10

Classes

PantalaimonClient
PantalaimonClient

Methods

# async createClientWithCredentials(username, password) → {Promise.<MatrixClient>}

Authenticates and creates the Pantalaimon-capable client. The username and password given are only used if the storage provider does not reveal an access token.
Parameters:
Name Type Description
username string The username to log in with, if needed.
password string The password to log in with, if needed.

View Source PantalaimonClient.ts, line 69

Resolves to a MatrixClient ready for interacting with Pantalaimon.
Promise.<MatrixClient>