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

Clarification/rewording on old and new sync-with-limit behaviour

Browse source
This commit is contained in:
Paul "LeoNerd" Evans 2016-04-19 18:26:01 +01:00
parent 98df455a99
commit 54624f397a
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
supporting-docs/howtos/client-server-migrating-from-v1.rst
View file

@ -49,13 +49,13 @@ following summary may be useful to compare with ``v1``:
only contains keys that have changed since the basis given in the ``since``
parameter, rather than containing a full set values.
* In ``/initialSync`` if the requested range contains more events than the
``limit`` parameter allows, then events from the start of this range were
* In ``/events`` if more events occurred since the ``since`` token than the
``limit`` parameter allowed, then events from the start of this range were
returned and the client must perform another fetch to incrementally obtain
more of them. In the ``/sync`` API the result always contains the end of the
requested range (i.e. the most recent events); possibly creating a gap. If
this occurs then the client can use the ``prev_batch`` token as a reference
to obtaining more.
more of them. In the ``/sync`` API the result always contains up to the most
recent event; creating a gap if this would be more events than the requested
limit. If this occurs then the client can use the ``prev_batch`` token as a
reference to obtaining more.
There is no direct replacement for the per-room ``/rooms/:roomId/initialSync``
endpoint, but the behaviour can be recreated by applying an ad-hoc filter using