Attempt to clarify how the `state` restriction works for lazy-loading

pull/977/head
Travis Ralston 4 years ago
parent 3943e63ae2
commit 1c7a6a9c7f

@ -42,12 +42,15 @@ paths:
full state of rooms is requested, to aid discovering the user's avatar & full state of rooms is requested, to aid discovering the user's avatar &
displayname. displayname.
Like other members, the user's own membership event is eligible Further, like other members, the user's own membership event is eligible
for being considered redundant by the server. When a sync is ``limited``, for being considered redundant by the server. When a sync is ``limited``,
the server MUST return membership events for events in the gap the server MUST return membership events for events in the gap
(between ``since`` and the start of the returned timeline), regardless (between ``since`` and the start of the returned timeline), regardless
as to whether or not they are redundant. This ensures that joins/leaves as to whether or not they are redundant. This ensures that joins/leaves
and profile changes which occur during the gap are not lost. and profile changes which occur during the gap are not lost.
Note that the default behaviour of ``state`` is to include all membership
events, alongside other state, when lazy-loading is not enabled.
operationId: sync operationId: sync
security: security:
- accessToken: [] - accessToken: []

Loading…
Cancel
Save