Merge pull request #1889 from ma1uta/push_rules

Fix for the #1865
5 years ago · c08d223cfe
parent f1280ef305 5303ba54b7
commit c08d223cfe
4 changed files with 216 additions and 0 deletions
--- a/changelogs/client_server/newsfragments/1889.clarification
+++ b/changelogs/client_server/newsfragments/1889.clarification
@ -0,0 +1 @@
+Add the missing `m.push_rules` event schema.
--- a/event-schemas/examples/m.push_rules
+++ b/event-schemas/examples/m.push_rules
@ -0,0 +1,192 @@
+{
+  "$ref": "core/event.json",
+  "type": "m.push_rules",
+  "content": {
+    "global": {
+      "content": [
+        {
+          "actions": [
+            "notify",
+            {
+              "set_tweak": "sound",
+              "value": "default"
+            },
+            {
+              "set_tweak": "highlight"
+            }
+          ],
+          "default": true,
+          "enabled": true,
+          "pattern": "alice",
+          "rule_id": ".m.rule.contains_user_name"
+        }
+      ],
+      "override": [
+        {
+          "actions": [
+            "dont_notify"
+          ],
+          "conditions": [],
+          "default": true,
+          "enabled": false,
+          "rule_id": ".m.rule.master"
+        },
+        {
+          "actions": [
+            "dont_notify"
+          ],
+          "conditions": [
+            {
+              "key": "content.msgtype",
+              "kind": "event_match",
+              "pattern": "m.notice"
+            }
+          ],
+          "default": true,
+          "enabled": true,
+          "rule_id": ".m.rule.suppress_notices"
+        }
+      ],
+      "room": [],
+      "sender": [],
+      "underride": [
+        {
+          "actions": [
+            "notify",
+            {
+              "set_tweak": "sound",
+              "value": "ring"
+            },
+            {
+              "set_tweak": "highlight",
+              "value": false
+            }
+          ],
+          "conditions": [
+            {
+              "key": "type",
+              "kind": "event_match",
+              "pattern": "m.call.invite"
+            }
+          ],
+          "default": true,
+          "enabled": true,
+          "rule_id": ".m.rule.call"
+        },
+        {
+          "actions": [
+            "notify",
+            {
+              "set_tweak": "sound",
+              "value": "default"
+            },
+            {
+              "set_tweak": "highlight"
+            }
+          ],
+          "conditions": [
+            {
+              "kind": "contains_display_name"
+            }
+          ],
+          "default": true,
+          "enabled": true,
+          "rule_id": ".m.rule.contains_display_name"
+        },
+        {
+          "actions": [
+            "notify",
+            {
+              "set_tweak": "sound",
+              "value": "default"
+            },
+            {
+              "set_tweak": "highlight",
+              "value": false
+            }
+          ],
+          "conditions": [
+            {
+              "is": "2",
+              "kind": "room_member_count"
+            }
+          ],
+          "default": true,
+          "enabled": true,
+          "rule_id": ".m.rule.room_one_to_one"
+        },
+        {
+          "actions": [
+            "notify",
+            {
+              "set_tweak": "sound",
+              "value": "default"
+            },
+            {
+              "set_tweak": "highlight",
+              "value": false
+            }
+          ],
+          "conditions": [
+            {
+              "key": "type",
+              "kind": "event_match",
+              "pattern": "m.room.member"
+            },
+            {
+              "key": "content.membership",
+              "kind": "event_match",
+              "pattern": "invite"
+            },
+            {
+              "key": "state_key",
+              "kind": "event_match",
+              "pattern": "@alice:example.com"
+            }
+          ],
+          "default": true,
+          "enabled": true,
+          "rule_id": ".m.rule.invite_for_me"
+        },
+        {
+          "actions": [
+            "notify",
+            {
+              "set_tweak": "highlight",
+              "value": false
+            }
+          ],
+          "conditions": [
+            {
+              "key": "type",
+              "kind": "event_match",
+              "pattern": "m.room.member"
+            }
+          ],
+          "default": true,
+          "enabled": true,
+          "rule_id": ".m.rule.member_event"
+        },
+        {
+          "actions": [
+            "notify",
+            {
+              "set_tweak": "highlight",
+              "value": false
+            }
+          ],
+          "conditions": [
+            {
+              "key": "type",
+              "kind": "event_match",
+              "pattern": "m.room.message"
+            }
+          ],
+          "default": true,
+          "enabled": true,
+          "rule_id": ".m.rule.message"
+        }
+      ]
+    }
+  }
+}
--- a/event-schemas/schema/m.push_rules
+++ b/event-schemas/schema/m.push_rules
@ -0,0 +1,21 @@
+---
+allOf:
+  - $ref: core-event-schema/event.yaml
+description: Describes all push rules for this user.
+properties:
+  content:
+    properties:
+      global:
+        type: object
+        title: Ruleset
+        description: The global ruleset
+        allOf:
+          - $ref: ../../api/client-server/definitions/push_ruleset.yaml
+    type: object
+  type:
+    enum:
+      - m.push_rules
+    type: string
+title: Push rules
+type: object
+
--- a/specification/modules/push.rst
+++ b/specification/modules/push.rst
@ -660,6 +660,8 @@ When a user changes their push rules a ``m.push_rules`` event is sent to all
 clients in the ``account_data`` section of their next ``/sync`` request. The
 content of the event is the current push rules for the user.

+{{m_push_rules_event}}
+
 Examples
 ++++++++