wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Start adding in push definitions

Browse source 
This is going to be painful to represent due to how the push API allows
mixed types (strings or objects) and mixed top-level keys ("content" rule kind
allowing "pattern" as a top-level key). We may wish to re-visit the design
of this API for v2.
This commit is contained in:
Kegan Dougal 2015-10-07 17:44:05 +01:00
parent 9540069acd
commit db25276856
5 changed files with 480 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
specification/modules/push.rst
View file

@ -81,12 +81,12 @@ To receive any notification pokes at all, it is necessary to configure a
'pusher' on the Home Server that you wish to receive notifications from. There
is a single API endpoint for this, as described below.
{{push_http_api}}
{{pusher_http_api}}
Push Rules
~~~~~~~~~~
Home Servers have an interface to configure what events trigger notifications.
This behaviour is configured through 'Push Rules'. Push Rules come in a variety
Homeservers have an interface to configure what events trigger notifications.
This behaviour is configured through "Push Rules". Push Rules come in a variety
of different kinds and each kind of rule has an associated priority. The
different kinds of rule, in descending order of priority, are:
@ -332,6 +332,8 @@ but instead have predefined conditions, the behaviour of which can be configured
using parameters named as described above. In the cases of room and sender
rules, the rule_id of the rule determines its behaviour.
{{pushrules_http_api}}
Push Rules: API
~~~~~~~~~~~~~~~
Rules live under a hierarchy in the REST API that resembles::