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

Apply suggestions from code review

Browse source 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
This commit is contained in:
Travis Ralston 2019-06-07 10:37:57 -06:00 • committed by GitHub
parent e4339fd687
commit a38af2009f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

6
api/client-server/message_pagination.yaml
View file

@ -115,14 +115,14 @@ paths:
type: array
description: |-
A list of state events relevant to showing the ``chunk``. For example, if
lazy-loading members is enabled in the filter then this will contain any
applicable membership events. Servers should be careful to not exclude
``lazy_load_members`` is enabled in the filter then this will contain any
the membership events for the the senders of events in the ``chunk``. Servers should be careful to not exclude
membership events which are older than ones already sent to the client.
Likewise, clients should be cautious and avoid using older membership
events as the current membership event when paginating backwards.
Unless ``include_redundant_members`` is ``true``, the server should remove
redundant members which would have already been sent to clients in prior calls
membership events which would have already been sent to clients in prior calls
to lazy-loading aware endpoints with the same filter.
items:
type: object

4
api/client-server/sync.yaml
View file

@ -41,8 +41,8 @@ paths:
syncing user's own membership event when they join a room, or when the
full state of rooms is requested. The user's own membership event is eligible
for being considered redundant by the server. When a sync is ``limited``,
the server MUST return membership events for events in the gap (from ``since``),
even if the applicable events are not in the response, regardless as to whether
the server MUST return membership events for events in the gap (between ``since`` and the start of the returned timeline),
regardless as to whether
or not they are redundant. ``include_redundant_members`` is ignored for limited
syncs.
operationId: sync

6
specification/client_server_api.rst
View file

@ -1286,7 +1286,7 @@ for the ``sender`` of events in the timeline, not all members of a room.
Repeated calls to lazy-loading aware endpoints will result in redundant membership
events being excluded by default. Clients often track which membership events they
already have, therefore making the extra information not as useful to the client.
Clients can always request redundant members by setting ``include_redundant_members``
Clients can always request redundant membership events by setting ``include_redundant_members``
to true in the filter.
Servers should be cautious about which events they consider redundant. Membership
@ -1296,9 +1296,9 @@ as the current membership event for a user.
.. Note::
Repeated calls using the same filter to *any* lazy-loading aware endpoint may
result in redundant members being excluded from future calls. For example, a
result in redundant membership events being excluded from future calls. For example, a
request to ``/sync`` followed by a request to ``/messages`` may result in a
future call to ``/sync`` excluding members included by the ``/messages`` call.
future call to ``/sync`` excluding membership events returned by the ``/messages`` call.
The current endpoints which support lazy-loading room members are: