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

SYN-270 Spec enable/disable API for push rules.

Browse source
This commit is contained in:
David Baker 2015-02-25 15:02:26 +00:00
parent 342146eafd
commit a39ad63a0b
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
drafts/push_csapi.rst
View file

@ -104,6 +104,8 @@ Server defined rules do not have a rule_id except when it is necessary to derive
the function of the rule (ie. in room and sender rules). Server default rules the function of the rule (ie. in room and sender rules). Server default rules
have an attribute, "default" set to true. have an attribute, "default" set to true.
In addition, all rules may be enabled or disabled. Disabled rules never match.
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
@ -254,7 +256,8 @@ Returns::
"actions": [ "actions": [
"dont_notify" "dont_notify"
], ],
"rule_id": "#spam:matrix.org" "rule_id": "#spam:matrix.org",
"enabled": true
} }
Clients can also fetch broader sets of rules by removing path components. Clients can also fetch broader sets of rules by removing path components.
@ -270,7 +273,8 @@ Requesting the root level returns a structure as follows::
"actions": [ "actions": [
"dont_notify" "dont_notify"
], ],
"rule_id": "#spam:matrix.org" "rule_id": "#spam:matrix.org",
"enabled", true
} }
], ],
"sender": [], "sender": [],
@ -289,3 +293,9 @@ Requesting the root level returns a structure as follows::
Adding patch components to the request drills down into this structure to filter Adding patch components to the request drills down into this structure to filter
to only the requested set of rules. to only the requested set of rules.
Enabling and Disabling Rules
----------------------------
Rules can be enabled or disabled with a PUT operation to the 'enabled' component
beneath the rule's URI with a content of 'true' or 'false'::
curl -X PUT -H "Content-Type: application/json" -d 'false' "http://localhost:8008/_matrix/client/api/v1/pushrules/global/sender/%40spambot%3Amatrix.org/enabled?access_token=123456"