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

Rework backwards compatibility section.

Browse source
This commit is contained in:
Patrick Cloke 2023-05-16 12:07:12 -04:00
parent a19626e525
commit ff51aa4b1d
1 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -38,20 +38,18 @@ Additionally, see the [`.m.rule.is_user_mention`](#_m_rule_is_user_mention) and
Users should not add their own Matrix ID to the `m.mentions` property as outgoing Users should not add their own Matrix ID to the `m.mentions` property as outgoing
messages cannot self-notify. messages cannot self-notify.
To disable legacy behaviour of notifications occurring due to matching against Note that, for backwards compatibility, push rules such as [`.m.rule.contains_display_name`](#_m_rule_contains_display_name),
the localpart of Matrix IDs and display names it is recommended that clients include [`.m.rule.contains_user_name`](#_m_rule_contains_user_name), and
a `m.mentions` property on each event. If there are no mentions to include it can [`.m.rule.roomnotif`](#_m_rule_roomnotif) continue to match if the `body` of
be an empty object. the event contains the user's display name or ID. To avoid unintentional notifications,
**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.)
{% boxes/rationale %} {% boxes/rationale %}
In previous versions of the specification, mentioning users was done by In previous versions of the specification, mentioning users was done by
including the user's display name or the localpart of their Matrix ID and room including the user's display name or the localpart of their Matrix ID and room
mentions were done by including the string "@room" in the plaintext `body` of mentions were done by including the string "@room" in the plaintext `body` of
the event. This was prone to confusing and buggy behaviour. the event. This was prone to confusing and buggy behaviour.
See the [`.m.rule.contains_display_name`](#_m_rule_contains_display_name),
[`.m.rule.contains_user_name`](#_m_rule_contains_user_name), and
[`.m.rule.roomnotif`](#_m_rule_roomnotif) deprecated push rules.
{% /boxes/rationale %} {% /boxes/rationale %}
#### Client behaviour #### Client behaviour