wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Spec for MSC2867 (Marking rooms as unread) (#1895)

Browse source 
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
This commit is contained in:
Johannes Marbach 2024-07-15 15:38:57 +02:00 • committed by GitHub
parent 40d5e48716
commit cbe8092d8a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 80 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
content/client-server-api/_index.md
View file

@ -2749,7 +2749,7 @@ that profile.
| [Event Annotations and reactions](#event-annotations-and-reactions) | Optional | Optional | Optional | Optional | Optional |
| [Event Context](#event-context) | Optional | Optional | Optional | Optional | Optional |
| [Event Replacements](#event-replacements) | Optional | Optional | Optional | Optional | Optional |
| [Fully read markers](#fully-read-markers) | Optional | Optional | Optional | Optional | Optional |
| [Read and Unread Markers](#read-and-unread-markers) | Optional | Optional | Optional | Optional | Optional |
| [Guest Access](#guest-access) | Optional | Optional | Optional | Optional | Optional |
| [Moderation Policy Lists](#moderation-policy-lists) | Optional | Optional | Optional | Optional | Optional |
| [OpenID](#openid) | Optional | Optional | Optional | Optional | Optional |

50
content/client-server-api/modules/read_markers.md
View file

@ -1,5 +1,6 @@
### Read and unread markers
### Fully read markers
#### Fully read markers
The history for a given room may be split into three sections: messages
the user has read (or indicated they aren't interested in them),
@ -8,7 +9,7 @@ user hasn't seen yet. The "fully read marker" (also known as a "read
marker") marks the last event of the first section, whereas the user's
read receipt marks the last event of the second section.
#### Events
##### Events
The user's fully read marker is kept as an event in the room's [account
data](#client-config). The event may be read to determine the user's
@ -22,7 +23,7 @@ should be considered to be the user's read receipt location.
{{% event event="m.fully_read" %}}
#### Client behaviour
##### Client behaviour
The client cannot update fully read markers by directly modifying the
`m.fully_read` account data event. Instead, the client must make use of
@ -41,7 +42,7 @@ might wish to save an extra HTTP call. Providing `m.read` and/or
{{% http-api spec="client-server" api="read_markers" %}}
#### Server behaviour
##### Server behaviour
The server MUST prevent clients from setting `m.fully_read` directly in
room account data. The server must additionally ensure that it treats
@ -53,3 +54,44 @@ Upon updating the `m.fully_read` event due to a request to
`/read_markers`, the server MUST send the updated account data event
through to the client via the event stream (eg: `/sync`), provided any
applicable filters are also satisfied.
#### Unread markers
Clients may use "unread markers" to allow users to label rooms for later
attention irrespective of [read receipts](#receipts) or
[fully read markers](#fully-read-markers).
##### Events
The user's unread marker in a room is kept under an `m.marked_unread`
event in the room's [account data](#client-config). The event may be read
to determine the user's current unread marker state in the room. Just
like other account data events, the event will be pushed down the event
stream when updated.
{{% event event="m.marked_unread" %}}
##### Client behaviour
Clients MUST update unread markers by directly modifying the `m.marked_unread`
room account data event. When marking a room as unread, clients SHOULD NOT change
the `m.fully_read` marker, so that the user's read position in the room is
retained.
When the `unread` field is `true`, clients SHOULD visually annotate the room
to indicate that it is unread. Exactly how this is achieved is left as an
implementation detail. It is RECOMMENDED that clients use a treatment similar
to how they represent rooms with unread notifications.
Clients SHOULD reset the unread marker by setting `unread` to `false` when
opening a room to display its timeline.
Clients that offer functionality to mark a room as _read_ by sending a read
receipt for the last event, SHOULD reset the unread marker simultaneously.
If the `m.marked_unread` event does not exist on the user's account data,
clients MUST behave as if `unread` was `false`.
##### Server behaviour
Servers have no additional requirements placed on them by this submodule.