Represents an application service's registration file. This is expected to be
loaded from another source, such as a YAML file.
Members
string
# id Optional
Optional ID for the appplication service. Used by homeservers to track which application
service registers what.
object
# namespaces
The various namespaces the application service can support.
Properties:
| Name | Type | Description |
|---|---|---|
users |
Array
|
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
|
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
|
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. |
boolean
# rate_limited Optional
If the application service is rate limited by the homeserver. Optional.
string
# sender_localpart
The application service's own localpart (eg: "_irc_bot" in the user ID "@_irc_bot:domain.com")
boolean
# undefined Optional
**Experimental**
Should the application service receive ephemeral events from the homeserver. Optional.