Clarify room mentions.

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
This commit is contained in:
Patrick Cloke 2023-05-16 10:56:13 -04:00 committed by GitHub
parent 993839afc4
commit ad5e0d8fdd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -10,7 +10,7 @@ This is achieved by including metadata in the `m.mentions` content property of
the event. The `m.mentions` property consists of an object with two fields: the event. The `m.mentions` property consists of an object with two fields:
* `user_ids`: A list of Matrix IDs of mentioned users. * `user_ids`: A list of Matrix IDs of mentioned users.
* `room`: A boolean set to `true` to mention the room. (`room` should otherwise * `room`: A boolean set to `true` to mention the room, for an `@room` notification. (`room` should otherwise
not be included on the event.) not be included on the event.)
Although it is possible to silently mention users, it is recommended to include a Although it is possible to silently mention users, it is recommended to include a