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

Spec additions to the push API for the web client

Browse source
This commit is contained in:
David Baker 2015-03-11 16:25:44 +00:00
parent bea6c84e46
commit 712da51c8c
2 changed files with 18 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
drafts/push_csapi.rst
View file

@ -42,7 +42,8 @@ data
pushers, this must contain a 'url' key which is a string of the URL that
should be used to send notifications.
If the pusher was created successfully, an empty JSON dictionary is returned.
If the pusher was created successfully, a JSON dictionary is returned (which may
be empty).
Push Rules
@ -246,11 +247,20 @@ that is sent in the notification poke. The following tweaks are defined:
sound
A sound to be played when this notification arrives. 'default' means to
play a default sound.
highlight
Whether or not this message should be highlighted in the UI. This will
normally take the form of presenting the message in a different colour and/or
weight. The UI might also be adjusted to draw particular attention to the room
in which the event occurred. The value may be omitted from the highlight
tweak, in which case it should be read as if it had a value of true.
Tweaks are passed transparently through the Home Server so client applications
and push gateways may agree on additional tweaks, for example, how to flash the
notification light on a mobile device.
If a kind of tweak that a client understands is not specified in an action, the
client may choose a sensible behaviour for the tweak.
Push Rules: Conditions:
-----------------------
Override, Underride and Default rules have a list of 'conditions'. All

7
drafts/push_pgwapi.rst
View file

@ -99,6 +99,13 @@ sound
Sets the sound file that should be played. 'default' means that a default
sound should be played.
And additional key is defined but only present on member events:
user_is_target
This is true if the user receiving the notification is the subject of a member
event (ie. the state_key of the member event is equal to the user's Matrix
ID).
The recipient of an HTTP notification should respond with an HTTP 2xx response
when the notification has been processed. If the endpoint returns an HTTP error
code, the Home Server should retry for a reasonable amount of time with a