Document how read receipts work over federation #1484
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
turt2live
added
the
blocked
35 tasks
Federation format: https://github.com/matrix-org/synapse/blob/d69decd5c78c72abef50b597a689e2bc55a39702/synapse/handlers/receipts.py#L153-L166 Population of the fields that the above uses to construct the EDU: https://github.com/matrix-org/synapse/blob/d69decd5c78c72abef50b597a689e2bc55a39702/synapse/handlers/receipts.py#L48-L56
turt2live
force-pushed
the
travis/s2s/read-receipts
branch
from
aa60209 to
e03bfbc
Compare
turt2live
removed
the
blocked
erikjohnston
requested changes
Aug 17, 2018
| type: array | ||
| description: |- | ||
| The event ID that the user has read up to. Must be exactly | ||
| one element in length. |
There was a problem hiding this comment.
Not really, no. Its the set of extremities that the user has read up to. (I think synapse cheats and mostly does only one entry). This is to support e.g. expressing you have read both sides of a fork.
specification/server_server_api.rst
Outdated
| -------- | ||
|
|
||
| Receipts are EDUs used to communicate a marker for a given event. Currently the | ||
| only kind of receipt supported is a "read receipt", or where in the timeline a |
There was a problem hiding this comment.
The timeline isn't a thing as far as federation is concerned, really.
There was a problem hiding this comment.
This is to try and relate the server-server spec to the client-server things. Suggestions on improved wording would be appreciated.
|
@erikjohnston please take another look |
erikjohnston
approved these changes
Aug 17, 2018
RiotTranslateBot
pushed a commit
to RiotTranslateBot/matrix-doc
that referenced
this pull request
Aug 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rendered: see 'docs' commit status.
This PR is blocked on #1463 as it makes use of the "definitions embedded in the spec" feature, and builds upon EDUs.
Blocked on:
Federation format: https://github.com/matrix-org/synapse/blob/d69decd5c78c72abef50b597a689e2bc55a39702/synapse/handlers/receipts.py#L153-L166
Population of the fields that the above uses to construct the EDU: https://github.com/matrix-org/synapse/blob/d69decd5c78c72abef50b597a689e2bc55a39702/synapse/handlers/receipts.py#L48-L56