More detail on using /sync with ad-hoc filters

pull/977/head
Paul "LeoNerd" Evans 9 years ago
parent 4f5ae82be9
commit a0de12f24e

@ -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::
GET .../sync?filter={"room":{"rooms":[$room_id]}}
See the new API documentation for details on the new return See the new API documentation for details on the new return value.
value.
The following endpoint is deprecated and has no direct replacement:: The following endpoint is deprecated and has no direct replacement::

Loading…
Cancel
Save