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

Clarify highlight and sound tweaks.

Browse source
This commit is contained in:
David Baker 2016-09-08 11:59:49 +01:00
parent 026a507380
commit 9a1db01d92
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
specification/modules/push.rst
View file

@ -189,14 +189,16 @@ tweaks are defined:
``sound`` ``sound``
A string representing the sound to be played when this notification arrives. A string representing the sound to be played when this notification arrives.
A value of ``default`` means to play a default sound. A value of ``default`` means to play a default sound. A device may choose to
alert the user by some other means if appropriate, eg. vibration.
``highlight`` ``highlight``
A boolean representing whether or not this message should be highlighted in A boolean representing whether or not this message should be highlighted in
the UI. This will normally take the form of presenting the message in a the UI. This will normally take the form of presenting the message in a
different colour and/or style. The UI might also be adjusted to draw different colour and/or style. The UI might also be adjusted to draw
particular attention to the room in which the event occurred. The ``value`` particular attention to the room in which the event occurred. If a
may be omitted from the highlight tweak, in which case it should default to ``highlight`` tweak is given with no value, its value is defined to be
``true``. ``true``. If no highlight tweak is given at all then the value of
``highlight`` is defined to be false.
Tweaks are passed transparently through the homeserver so client applications Tweaks are passed transparently through the homeserver so client applications
and Push Gateways may agree on additional tweaks. For example, a tweak may be and Push Gateways may agree on additional tweaks. For example, a tweak may be