Remove the `dont_notify` and `coalesce` push rule actions. (#1501)

* Remove the `dont_notify` and `coalesce` push rule actions.

Per MSC3987, these should both be considered no-ops.

* Remove obsolete dont_notify from default rules.

* Remove obsolete dont_notify from examples.
pull/1509/head
Patrick Cloke 2 years ago committed by GitHub
parent 283c5877fe
commit e1dc5f8f53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1 @@
Remove the `dont_notify` and `coalesce` push rule actions per [MSC3987](https://github.com/matrix-org/matrix-spec-proposals/pull/3987).

@ -147,17 +147,6 @@ actions are defined:
: This causes each matching event to generate a notification. : This causes each matching event to generate a notification.
`dont_notify`
: This prevents each matching event from generating a notification.
`coalesce`
: This enables notifications for matching events but activates homeserver
specific behaviour to intelligently coalesce multiple events into a
single notification. Not all homeservers may support this. Those that do
not support it should treat it as the `notify` action.
`set_tweak` `set_tweak`
: Sets an entry in the `tweaks` dictionary key that is sent in the : Sets an entry in the `tweaks` dictionary key that is sent in the
@ -195,6 +184,12 @@ they are represented as a dictionary with a key equal to their name and
other keys as their parameters, e.g. other keys as their parameters, e.g.
`{ "set_tweak": "sound", "value": "default" }`. `{ "set_tweak": "sound", "value": "default" }`.
{{% boxes/note %}}
Older versions of the Matrix specification included the `dont_notify` and
`coalesce` actions. These should both be considered no-ops (ignored, not
rejected) if received from a client.
{{% /boxes/note %}}
##### Conditions ##### Conditions
`override` and `underride` rules MAY have a list of 'conditions'. All `override` and `underride` rules MAY have a list of 'conditions'. All
@ -440,9 +435,7 @@ Definition:
"default": true, "default": true,
"enabled": false, "enabled": false,
"conditions": [], "conditions": [],
"actions": [ "actions": []
"dont_notify"
]
} }
``` ```
@ -464,9 +457,7 @@ Definition:
"pattern": "m.notice", "pattern": "m.notice",
} }
], ],
"actions": [ "actions": []
"dont_notify",
]
} }
``` ```
@ -526,9 +517,7 @@ Definition:
"pattern": "m.room.member" "pattern": "m.room.member"
} }
], ],
"actions": [ "actions": []
"dont_notify"
]
} }
``` ```
@ -882,14 +871,14 @@ To create a rule that suppresses notifications for the room with ID
curl -X PUT -H "Content-Type: application/json" "https://example.com/_matrix/client/v3/pushrules/global/room/%21dj234r78wl45Gh4D%3Amatrix.org?access_token=123456" -d \ curl -X PUT -H "Content-Type: application/json" "https://example.com/_matrix/client/v3/pushrules/global/room/%21dj234r78wl45Gh4D%3Amatrix.org?access_token=123456" -d \
'{ '{
"actions" : ["dont_notify"] "actions" : []
}' }'
To suppress notifications for the user `@spambot:matrix.org`: To suppress notifications for the user `@spambot:matrix.org`:
curl -X PUT -H "Content-Type: application/json" "https://example.com/_matrix/client/v3/pushrules/global/sender/%40spambot%3Amatrix.org?access_token=123456" -d \ curl -X PUT -H "Content-Type: application/json" "https://example.com/_matrix/client/v3/pushrules/global/sender/%40spambot%3Amatrix.org?access_token=123456" -d \
'{ '{
"actions" : ["dont_notify"] "actions" : []
}' }'
To always notify for messages that contain the work 'cake' and set a To always notify for messages that contain the work 'cake' and set a

@ -75,18 +75,14 @@ paths:
], ],
"override": [ "override": [
{ {
"actions": [ "actions": [],
"dont_notify"
],
"conditions": [], "conditions": [],
"default": true, "default": true,
"enabled": false, "enabled": false,
"rule_id": ".m.rule.master" "rule_id": ".m.rule.master"
}, },
{ {
"actions": [ "actions": [],
"dont_notify"
],
"conditions": [ "conditions": [
{ {
"key": "content.msgtype", "key": "content.msgtype",
@ -286,9 +282,7 @@ paths:
rule itself such as the rule's `actions` and `conditions` if set. rule itself such as the rule's `actions` and `conditions` if set.
examples: examples:
application/json: { application/json: {
"actions": [ "actions": [],
"dont_notify"
],
"pattern": "cake*lie", "pattern": "cake*lie",
"rule_id": "nocake", "rule_id": "nocake",
"enabled": true, "enabled": true,

@ -23,18 +23,14 @@
], ],
"override": [ "override": [
{ {
"actions": [ "actions": [],
"dont_notify"
],
"conditions": [], "conditions": [],
"default": true, "default": true,
"enabled": false, "enabled": false,
"rule_id": ".m.rule.master" "rule_id": ".m.rule.master"
}, },
{ {
"actions": [ "actions": [],
"dont_notify"
],
"conditions": [ "conditions": [
{ {
"key": "content.msgtype", "key": "content.msgtype",

Loading…
Cancel
Save