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

Change server default rules.

Browse source
This commit is contained in:
David Baker 2015-02-05 10:49:48 +00:00
parent 8184855d5a
commit e6c9e77d35
1 changed files with 12 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

67
drafts/push_csapi.rst
View file

@ -69,15 +69,12 @@ Sender
Underride Underride
These are identical to override rules, but have a lower priority than content, These are identical to override rules, but have a lower priority than content,
room and sender rules. room and sender rules.
Default
These are rules provided by the home server and cannot be changed by the user.
They are the lowest priority rule and establish baseline behaviour.
In addition, each kind of rule except default may be either global or In addition, each kind of rule may be either global or device-specific. Device
device-specific. Device specific rules only affect delivery of notifications via specific rules only affect delivery of notifications via pushers with a matching
pushers with a matching profile_tag. All device-specific rules are higher profile_tag. All device-specific rules are higher priority than all global
priority than all global rules. Thusly, the full list of rule kinds, in rules. Thusly, the full list of rule kinds, in descending priority order, is as
descending priority order, is as follows: follows:
* Device-specific Override * Device-specific Override
* Device-specific Content * Device-specific Content
@ -89,7 +86,6 @@ descending priority order, is as follows:
* Global Room * Global Room
* Global Sender * Global Sender
* Global Underride * Global Underride
* Global Default
For some kinds of rule, rules of the same kind also have an ordering with 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
@ -103,6 +99,11 @@ alphanumeric characters only. The rule_id is unique within the kind of rule and
scope: rule_ids need not be unique between rules of the same kind on different scope: rule_ids need not be unique between rules of the same kind on different
devices. devices.
A home server may also have server default rules of each kind and in each scope.
Server default rules are lower priority than user-defined rules in eacgh scope.
Server defined rules do not have a rule_id. A rule has a rule_id if and only if
it is a user-defined rule.
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
@ -189,8 +190,7 @@ scope
Either 'global' or 'device/<profile_tag>' to specify global rules or Either 'global' or 'device/<profile_tag>' to specify global rules or
device rules for the given profile_tag. device rules for the given profile_tag.
kind kind
The kind of rule, ie. 'override', 'underride', 'sender', 'room', 'content' or The kind of rule, ie. 'override', 'underride', 'sender', 'room', 'content'.
'default'.
rule_id rule_id
The identifier for the rule. The identifier for the rule.
@ -262,7 +262,6 @@ Requesting the root level returns a structure as follows::
"device": { "device": {
"exampledevice": { "exampledevice": {
"content": [], "content": [],
"default": [],
"override": [], "override": [],
"room": [ "room": [
{ {
@ -278,50 +277,6 @@ Requesting the root level returns a structure as follows::
}, },
"global": { "global": {
"content": [], "content": [],
"default": [
{
"actions": [
"notify",
{
"set_sound": "default"
}
],
"conditions": [
{
"key": "content.body",
"kind": "event_match",
"pattern": "*@test:steve*"
}
]
},
{
"actions": [
"notify",
{
"set_sound": "default"
}
],
"conditions": [
{
"kind": "contains_display_name"
}
]
},
{
"actions": [
"notify",
{
"set_sound": "default"
}
],
"conditions": [
{
"is": "2",
"kind": "room_member_count"
}
]
}
],
"override": [], "override": [],
"room": [], "room": [],
"sender": [], "sender": [],