Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-26 13:04:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add information on MSC3758: event_property_is.

Browse source
This commit is contained in:
Patrick Cloke 2023-03-14 09:15:52 -04:00
parent 53d7de2376
commit c4e64387a2
1 changed files with 47 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
content/client-server-api/modules/push.md
View file

@ -212,7 +212,7 @@ The following conditions are defined:
**`event_match`** **`event_match`**
This is a glob pattern match on a field of the event. Parameters: This is a glob pattern match on a property of the event. Parameters:
- `key`: The dot-separated path of the property of the event to match, e.g. - `key`: The dot-separated path of the property of the event to match, e.g.
`content.body`. `content.body`.
@ -220,7 +220,7 @@ This is a glob pattern match on a field of the event. Parameters:
- `pattern`: The [glob-style pattern](/appendices#glob-style-matching) to match against. - `pattern`: The [glob-style pattern](/appendices#glob-style-matching) to match against.
The match is performed case-insensitively, and must match the entire value of The match is performed case-insensitively, and must match the entire value of
the event field given by `key` (though see below regarding `content.body`). The the event property given by `key` (though see below regarding `content.body`). The
exact meaning of "case insensitive" is defined by the implementation of the exact meaning of "case insensitive" is defined by the implementation of the
homeserver. homeserver.
@ -267,7 +267,7 @@ following event will match:
```json ```json
{ {
"content": { "content": {
"body": "An example event.", "body": "An example event."
}, },
"event_id": "$143273976499sgjks:example.org", "event_id": "$143273976499sgjks:example.org",
"room_id": "!636q39766251:example.com", "room_id": "!636q39766251:example.com",
@ -293,6 +293,50 @@ For an example of this, see the default rule
[`.m.rule.tombstone`](#mruletombstone) below. [`.m.rule.tombstone`](#mruletombstone) below.
{{% /boxes/warning %}} {{% /boxes/warning %}}
**`event_property_is`**
This is an exact value match on a property of the event. Parameters:
- `key`: The dot-separated path of the property of the event to match, e.g.
`content.body`.
- `value`: The value to match against.
The match is performed exactly and only supports strings, integers, booleans, and
`null`.
If the property specified by `key` is completely absent from the event, or does
not have a string, integer, boolean, or `null` value, then the condition will not
match.
{{% boxes/note %}}
For example, if `key` is `content.m.federate`, and `value` is `true`, then
the following event will match:
```json
{
"content": {
"creator": "@example:example.org",
"m.federate": true,
"predecessor": {
"event_id": "$something:example.org",
"room_id": "!oldroom:example.org"
},
"room_version": "1"
},
"event_id": "$143273582443PhrSn:example.org",
"room_id": "!636q39766251:example.com",
"sender": "@example:example.org",
"state_key": "",
"type": "m.room.create"
}
```
The following `m.federate` values will NOT match:
* `"true"` (note the string value)
* `1` (do not cast types)
{{% /boxes/note %}}
**`contains_display_name`** **`contains_display_name`**
This matches messages where `content.body` contains the owner's display name in This matches messages where `content.body` contains the owner's display name in