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

Replace set_sound with more generic set_tweaks.

Browse source
This commit is contained in:
David Baker 2015-02-03 15:38:12 +00:00
parent 8920d58cc4
commit 91d12dc955
1 changed files with 23 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

32
drafts/push_csapi.rst
View file

@ -97,8 +97,8 @@ For some kinds of rule, rules of the same kind also have an ordering with
respect to one another. The kinds that do not are room and sender rules where respect to one another. The kinds that do not are room and sender rules where
the rules are mutually exclusive by definition and therefore an ordering would the rules are mutually exclusive by definition and therefore an ordering would
be redundant. Actions for the highest priority rule and only that rule apply be redundant. Actions for the highest priority rule and only that rule apply
(for example, a set_sound action in a lower priority rule will not apply if a (for example, a set_tweak action in a lower priority rule will not apply if a
higher priority rule matches, even if that rule does not specify a sound). higher priority rule matches, even if that rule does not specify any tweaks).
Rules also have an identifier, rule_id, which is a string. Rules also have an identifier, rule_id, which is a string.
@ -118,14 +118,28 @@ coalesce
specific behaviour to intelligently coalesce multiple events into a single specific behaviour to intelligently coalesce multiple events into a single
notification. Not all Home Servers may support this. Those that do not should notification. Not all Home Servers may support this. Those that do not should
treat it as the 'notify' action. treat it as the 'notify' action.
set_sound set_tweak
Sets the value 'sound' key that is sent in the notification poke. This has an Sets an entry in the 'tweaks' dictionary key that is sent in the notification
associated string which is the value to set the 'sound' key to. poke. This takes the form of a dictionary with a 'set_tweak' key whose value
is the name of the tweak to set. It must also have a 'value' key which is
the value to which it should be set.
Actions that have no parameter are represented as a string. Those with a Actions that have no parameters are represented as a string. Otherwise, they are
parameter are represented as a dictionary with a single key/value pair where the represented as a dictionary with a key equal to their name and other keys as
key is the name of the action and the value is the parameter, eg. { "set_sound": their parameters, eg. { "set_tweak": "sound", "value": "default" }
"ping.wav" }
Push Rule Actions: Tweaks
-------------------------
The 'set_tweak' key action is used to add an entry to the 'tweaks' dictionary
that is sent in the notification poke. The following tweaks are e defined:
sound
A sound to be played when this notification arrives. 'default' means to
play a default sound.
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.
Push Rules: Conditions: Push Rules: Conditions:
----------------------- -----------------------