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

Another rewording of 'state' returned by '/sync' with 'since' parameter

Browse source
This commit is contained in:
Paul "LeoNerd" Evans 2016-04-20 15:04:23 +01:00
parent 8f22cf6cb8
commit ea6ac3e40f
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -45,10 +45,6 @@ following summary may be useful to compare with ``v1``:
for clients to represent state changes that occur within the region of
returned timeline.
* Additionally, the ``state`` contained in the ``/sync`` response by default
only contains keys that have changed since the basis given in the ``since``
parameter, rather than containing a full set values.
* 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 had to perform another fetch to incrementally obtain
@ -57,6 +53,11 @@ following summary may be useful to compare with ``v1``:
requested limit. If this occurs then the client can use the ``prev_batch``
token as a reference to obtaining more.
* Additionally, the ``state`` contained in the ``/sync`` response that has a
``since`` parameter will contains only keys that have changed since the
basis given in the ``since`` parameter, rather than containing a full set
values.
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
the ``filter`` parameter to ``/sync`` that selects only the required room ID::