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

Add some notes about what/when to include the m.mentions property.

Browse source
This commit is contained in:
Patrick Cloke 2023-05-03 15:28:07 -04:00
parent b16b850731
commit ebda37ea8c
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
content/client-server-api/modules/mentions.md
View file

@ -45,6 +45,13 @@ Similarly, the entire room can be mentioned:
```
Additionally, see [the `.m.rule.is_user_mention` and `.m.rule.is_room_mention` push rules](#predefined-rules).
Users should not add their own Matrix ID to the `m.mentions` property as outgoing
messages cannot self-notify.
To disable legacy behaviour of notifications occurring due to matching against
the localpart of Matrix IDs and display names it is recommended that clients include
a `m.mentions` property on each event. If there are no mentions to include it can
be an empty object.
#### Client behaviour
@ -78,10 +85,6 @@ user or room information.
TODO Behavior with edits.
TODO Always include `m.mentions` property.
TODO Note that users should *never* include their own Matrix ID in `m.mentions`.
{{% boxes/note %}}
Similar to legacy [matrix.to URLs](/appendices/#matrixto-navigation),
groups used to be representable by mentions. They follow a similar format