Interface

IAppserviceRegistration

IAppserviceRegistration

Represents an application service's registration file. This is expected to be loaded from another source, such as a YAML file.

View Source appservice/Appservice.ts, line 911

Members

string

# as_token

The token the application service uses to communicate with the homeserver.

View Source appservice/Appservice.ts, line 929

string

# hs_token

The token the homeserver uses to communicate with the application service.

View Source appservice/Appservice.ts, line 934

string

# id Optional

Optional ID for the appplication service. Used by homeservers to track which application service registers what.

View Source appservice/Appservice.ts, line 917

object

# namespaces

The various namespaces the application service can support.
Properties:
Name Type Attributes Description
users Array <optional>
The user namespaces the application service is requesting.
users[].exclusive boolean Whether or not the application service holds an exclusive lock on the namespace. This, means that no other user on the homeserver may register users that match this namespace.
users[].regex string The regular expression that the homeserver uses to determine if a user is in this namespace.
rooms Array <optional>
The room namespaces the application service is requesting. This is not for alises.
rooms[].exclusive boolean Whether or not the application service holds an exclusive lock on the namespace.
rooms[].regex string The regular expression that the homeserver uses to determine if a user is in this namespace.
aliases Array <optional>
The room alias namespaces the application service is requesting.
aliases[].exclusive boolean Whether or not the application service holds an exclusive lock on the namespace. This means, that no other user on the homeserver may register aliases that match this namespace.
aliases[].regex string The regular expression that the homeserver uses to determine if an alias is in this namespace.

View Source appservice/Appservice.ts, line 944

Array

# protocols Optional

The protocols the application service supports. Optional.

View Source appservice/Appservice.ts, line 960

boolean

# rate_limited Optional

If the application service is rate limited by the homeserver. Optional.

View Source appservice/Appservice.ts, line 966

string

# sender_localpart

The application service's own localpart (eg: "_irc_bot" in the user ID "@_irc_bot:domain.com")

View Source appservice/Appservice.ts, line 939

boolean

# undefined Optional

**Experimental** Should the application service receive ephemeral events from the homeserver. Optional.
See:

View Source appservice/Appservice.ts, line 972

boolean

# undefined Optional

** Experimental ** Should the AS use the new device management APIs. Optional.
See:

View Source appservice/Appservice.ts, line 981

string | null

# url

URL at which the application service can be contacted. If not in use, this must be `null`.

View Source appservice/Appservice.ts, line 924