Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-07 12:14:10 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

More detail on using /sync with ad-hoc filters

Browse source
This commit is contained in:
Paul "LeoNerd" Evans 2016-04-14 18:35:49 +01:00
parent 4f5ae82be9
commit a0de12f24e
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -31,14 +31,18 @@ The following endpoints are now deprecated and replaced by the ``/sync`` API::
The new ``/sync`` API takes an optional ``since`` parameter to distinguish the The new ``/sync`` API takes an optional ``since`` parameter to distinguish the
initial sync from subsequent updates for more events. These return data in a initial sync from subsequent updates for more events. These return data in a
different format. different format. Instead of the ``limit`` parameter, supply an ad-hoc filter
that provides the required event count::
GET .../sync?filter={"room":{"timeline":{"limit:$limit}}}
There is no direct replacement for the per-room ``/rooms/:roomId/initialSync`` 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 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. the ``filter`` parameter to ``/sync`` that selects only the required room ID::
See the new API documentation for details on the new return GET .../sync?filter={"room":{"rooms":[$room_id]}}
value.
See the new API documentation for details on the new return value.
The following endpoint is deprecated and has no direct replacement:: The following endpoint is deprecated and has no direct replacement::