mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-11-24 18:45:52 +03:00
Code Issues Projects Releases Packages Wiki Activity

Sliding Sync: Fix limited response description (make accurate) (#17507)

Browse source
This commit is contained in:
Eric Eastwood 2024-07-31 11:47:26 -05:00 committed by GitHub
parent 46de0ee16b
commit 1d6186265a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/17507.misc Normal file
View file

@ -0,0 +1 @@
Update the `limited` field description in the Sliding Sync response to accurately describe what it actually represents.

4
synapse/types/handlers/__init__.py
View file

@ -182,8 +182,8 @@ class SlidingSyncResult:
absent on joined/left rooms absent on joined/left rooms
prev_batch: A token that can be passed as a start parameter to the prev_batch: A token that can be passed as a start parameter to the
`/rooms/<room_id>/messages` API to retrieve earlier messages. `/rooms/<room_id>/messages` API to retrieve earlier messages.
limited: True if their are more events than fit between the given position and now. limited: True if there are more events than `timeline_limit` looking
Sync again to get more. backwards from the `response.pos` to the `request.pos`.
num_live: The number of timeline events which have just occurred and are not historical. num_live: The number of timeline events which have just occurred and are not historical.
The last N events are 'live' and should be treated as such. This is mostly The last N events are 'live' and should be treated as such. This is mostly
useful to determine whether a given @mention event should make a noise or not. useful to determine whether a given @mention event should make a noise or not.