You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
matrix-spec/content/client-server-api/modules/mentions.md

3.8 KiB

User and room mentions

{{% changed-in v="1.7" %}}

This module allows users to "mention" other users and rooms within a room event. This is primarily used as an indicator that the recipient should receive a notification about the event. This is achieved by including metadata in the m.mentions content property of the event to reference the entity being mentioned.

m.mentions is defined as follows:

{{% definition path="api/client-server/definitions/m.mentions" %}}

An event's content will then look like this:

{
    "body": "Hello Alice!",
    "msgtype": "m.text",
    "format": "org.matrix.custom.html",
    "formatted_body": "Hello <a href='https://matrix.to/#/@alice:example.org'>Alice</a>!",
    "m.mentions": {
        "user_ids": ["@alice:example.org"]
    }
}

Additionally, see the .m.rule.is_user_mention and .m.rule.is_room_mention push rules. Users should not add their own Matrix ID to the m.mentions property as outgoing messages cannot self-notify.

{{% boxes/warning %}} If an encrypted event contains an m.mentions in its payload, it should be encrypted as normal. To properly process mentions in encrypted rooms, events must be decrypted first. See receiving notifications. {{% /boxes/warning %}}

Note that, for backwards compatibility, push rules such as .m.rule.contains_display_name, .m.rule.contains_user_name, and .m.rule.roomnotif continue to match if the body of 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 %}} 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 mentions were done by including the string "@room" in the plaintext body of the event. This was prone to confusing and buggy behaviour. {{% /boxes/rationale %}}

Client behaviour

Although it is possible to silently mention users, it is recommended to include a Matrix URI in the HTML body of an m.room.message event. This applies only to m.room.message events where the msgtype is m.text, m.emote, or m.notice. The format for the event must be org.matrix.custom.html and therefore requires a formatted_body.

Clients should use the following guidelines when adding a Matrix URI representing a mention to events to be sent:

  • When linking to users, use the user's potentially ambiguous display name for the anchor's text. If the user does not have a display name, use the user's ID.
  • When linking to rooms, use the canonical alias for the room. If the room does not have a canonical alias, prefer one of the aliases listed on the room. If no alias can be found, fall back to the room ID. In all cases, use the alias/room ID being linked to as the anchor's text.

The text component of the anchor should be used in the event's body where the link would normally be represented, as shown in the example above.

Clients should display mentions differently from other elements. For example, this may be done by changing the background color of the mention to indicate that it is different from a normal link.

If the current user is mentioned in a message, the client should show that mention differently from other mentions, such as by using a red background color to signify to the user that they were mentioned. Note that it is possible for a user to be mentioned without including their Matrix URI in the event.

When clicked, the mention should navigate the user to the appropriate user or room information.