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

Finish non-API doc parts of push rules.

Browse source
This commit is contained in:
David Baker 2015-02-02 16:25:53 +00:00
parent f68fa8d6f8
commit b7a6e8f7b5
1 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
drafts/push_csapi.rst
View file

@ -60,7 +60,9 @@ Override Rules
The highest priority rules are user-configured overrides. The highest priority rules are user-configured overrides.
Content Rules Content Rules
These configure behaviour for (unencrypted) messages that match certain These configure behaviour for (unencrypted) messages that match certain
patterns. patterns. Content rules take one parameter, 'pattern', that gives the pattern
to match against. This is treated in the same way as pattern for event_match
conditions, below.
Room Rules Room Rules
These change the behaviour of all messages to a given room. The rule_id of a These change the behaviour of all messages to a given room. The rule_id of a
room rule is always the room that it affects. room rule is always the room that it affects.
@ -100,6 +102,8 @@ 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_sound 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 a sound).
Rules also have an identifier, rule_id, which is a string.
Push Rules: Actions: Push Rules: Actions:
-------------------- --------------------
All rules have an associated list of 'actions'. An action affects if and how a All rules have an associated list of 'actions'. An action affects if and how a
@ -155,3 +159,8 @@ room_member_count
this matches rooms where the member count is exactly equal to the given this matches rooms where the member count is exactly equal to the given
number (ie. the same as '=='). number (ie. the same as '==').
Room, Sender, User and Content rules do not have conditions in the same way,
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.