Interface

IAppserviceOptions

IAppserviceOptions

General options for the application service

View Source appservice/Appservice.ts, line 990

Members

string

# aliasPrefix Optional

If provided, use this as the alias prefix rather than calculating from the namespace.

View Source appservice/Appservice.ts, line 1045

string

# bindAddress

The bind address to listen for requests on.

View Source appservice/Appservice.ts, line 1000

IAppserviceCryptoStorageProvider

# cryptoStorage Optional

The storage provider to use for setting up encryption. Encryption will be disabled for all intents and the appservice if not configured.

View Source appservice/Appservice.ts, line 1021

string

# homeserverName

The name of the homeserver, as presented over federation (eg: "matrix.org")

View Source appservice/Appservice.ts, line 1005

string

# homeserverUrl

The URL to the homeserver's client server API (eg: "https://matrix.org")

View Source appservice/Appservice.ts, line 1010

object

# intentOptions Optional

Options for how Intents are handled.
Properties:
Name Type Attributes Description
maxCached number <optional>
The maximum number of intents to keep cached. Defaults to 10 thousand.
maxAgeMs number <optional>
The maximum age in milliseconds to keep an Intent around for, provided, the maximum number of intents has been reached. Defaults to 60 minutes.
encryption boolean <optional>
If false (default), crypto will not be automatically set up for all intent, instances - it will need to be manually enabled with, `await intent.enableEncryption()`., , If true, crypto will be automatically set up., , Note that the appservice bot account is considered an intent.
enableContentScanner boolean <optional>
Enable the content scanner API when creating new intents. This means, that all media requests will be proxied through the scanner.

View Source appservice/Appservice.ts, line 1051

IJoinRoomStrategy

# joinStrategy Optional

The join strategy to use for all intents, if any.

View Source appservice/Appservice.ts, line 1033

number

# port

The port to listen for requests from the homeserver on.

View Source appservice/Appservice.ts, line 995

IAppserviceRegistration

# registration

The registration for this application service.

View Source appservice/Appservice.ts, line 1028

IAppserviceStorageProvider

# storage Optional

The storage provider to use for this application service.

View Source appservice/Appservice.ts, line 1015

string

# userPrefix Optional

If provided, use this as the user prefix rather than calculating from the namespace.

View Source appservice/Appservice.ts, line 1039