Skip to content

Commit

Permalink
Add back full example
Browse files Browse the repository at this point in the history
Signed-off-by: Kévin Commaille <[email protected]>
  • Loading branch information
zecakeh committed Sep 12, 2023
1 parent c19cc4a commit 1907de2
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions content/client-server-api/modules/mentions.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ the event to reference the entity being mentioned.

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

An event's content will then look like this:

```json
{
"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`](#_m_rule_is_user_mention) and
[`.m.rule.is_room_mention`](#_m_rule_is_room_mention) push rules.
Users should not add their own Matrix ID to the `m.mentions` property as outgoing
Expand Down

0 comments on commit 1907de2

Please sign in to comment.