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

incorporate LL review from matthew

Browse source
This commit is contained in:
Matthew Hodgson 2019-06-10 19:38:44 +01:00
parent a38af2009f
commit 0506d09cf7
5 changed files with 60 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

3
api/client-server/definitions/room_event_filter.yaml
View file

@ -25,7 +25,8 @@ allOf:
include_redundant_members:
type: boolean
description: |-
If ``true``, enables redundant membership events. Does not
If ``true``, sends all membership events for all events, even if they have already
been sent to the client. Does not
apply unless ``lazy_load_members`` is ``true``. See
`Lazy-loading room members <#lazy-loading-room-members>`_
for more information. Defaults to ``false``.

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

@ -115,15 +115,13 @@ paths:
type: array
description: |-
A list of state events relevant to showing the ``chunk``. For example, if
``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.
``lazy_load_members`` is enabled in the filter then this may contain
the membership events for the senders of events in the ``chunk``.
Unless ``include_redundant_members`` is ``true``, the server should remove
membership events which would have already been sent to clients in prior calls
to lazy-loading aware endpoints with the same filter.
Unless ``include_redundant_members`` is ``true``, the server
may remove membership events which would have already been
sent to the client in prior calls to this endpoint, assuming
the membership of those members has not changed.
items:
type: object
title: RoomStateEvent

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

@ -39,12 +39,15 @@ paths:
for more information. Lazy-loading members is only supported on a ``StateFilter``
for this endpoint. When lazy-loading is enabled, servers MUST include the
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
full state of rooms is requested, to aid discovering the user's avatar &
displayname.
Like other members, 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 (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.
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. This ensures that joins/leaves
and profile changes which occur during the gap are not lost.
operationId: sync
security:
- accessToken: []
@ -149,9 +152,9 @@ paths:
type: array
description: |-
The users which can be used to generate a room name
if the room does not have one. Required if the room
does not have a ``m.room.name`` or ``m.room.canonical_alias``
state event with non-empty content.
if the room does not have one. Required if the room's
``m.room.name`` or ``m.room.canonical_alias`` state events
are unset or empty.
This should be the first 5 members of the room, ordered
by stream ordering, which are joined or invited. The