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

More WIP API docs and remove spurious line.

Browse source
This commit is contained in:
David Baker 2015-02-02 17:10:09 +00:00
parent b7a6e8f7b5
commit 0c79798f70
1 changed files with 17 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

19
drafts/push_csapi.rst
View file

@ -7,8 +7,6 @@ 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 'pusher' on the Home Server that you wish to receive notifications from. There
is a single API endpoint for this:: is a single API endpoint for this::
Fetching a user account displayname::
POST $PREFIX/pushers/set POST $PREFIX/pushers/set
This takes a JSON object with the following keys: This takes a JSON object with the following keys:
@ -164,3 +162,20 @@ 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 using parameters named as described above. In the cases of room and sender
rules, the rule_id of the rule determines its behaviour. rules, the rule_id of the rule determines its behaviour.
Push Rules: API
---------------
Rules live under a hierarchy in the REST API that resembles::
$PREFIX/pushrules/<scope>/<kind>/<rule_id>
To add or change a rule, a client performs a PUT request to the appropriate URL.
When adding rules of a type that has an ordering, the client can add parameters
that define the priority of the rule:
before
Use 'before' with a rule_id as its value to make the new rule the next-less
important rule with respect to the given rule.
after
This makes the new rule the next-most important rule relative to the given
rule.