Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

First draft of AS filters #1300

Closed
wants to merge 2 commits into from
Closed

First draft of AS filters #1300

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
480484a
First draft of AS filter exludes
Half-Shot Jun 13, 2018
374bb56
Incorporate feedback
Half-Shot Jun 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions specification/application_service_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,11 @@ traffic to the AS is:
- ...
aliases: [] # Namespaces of room aliases which should be delegated to the AS
rooms: [] # Namespaces of room ids which should be delegated to the AS
filter:
include_virtual_users: <bool> # This will exclude traffic from virtual users being
# received on the AS. Defaults to true.
include_as_user: <bool> # This will exclude traffic from the AS user
# being received on the AS. Defaults to true.

.. WARNING::
If the homeserver in question has multiple application services, each
Expand Down Expand Up @@ -143,6 +148,16 @@ be made without blocking other aspects of the homeserver. Homeservers MUST NOT
alter (e.g. add more) events they were going to send within that transaction ID
on retries, as the AS may have already processed the events.

.. NOTE::
Please note the filter options in the registration object above. Homeservers
should exclude traffic to each application service based on the filters they
have set. If an option is not set, the homeserver MUST adhere to the default
value.

Additionally the filters are within the context of the transaction API. The
Client Server API MUST continue to show events that may be excluded by the
filter.

Querying
++++++++

Expand Down