Generalize wording to fit /messages and /sync

pull/977/head
Travis Ralston 6 years ago
parent e7ed8a23ce
commit d56df3238c

@ -19,28 +19,32 @@ allOf:
lazy_load_members: lazy_load_members:
type: boolean type: boolean
description: |- description: |-
If ``true``, the only ``m.room.member`` events returned in If ``true``, the only ``m.room.member`` events returned
the ``state`` section of the ``/sync`` response are those are those which are definitely necessary for a client to
which are definitely necessary for a client to display display the ``sender`` of the timeline events in the response.
the ``sender`` of the timeline events in that response.
If ``false``, ``m.room.member`` events are not filtered. If ``false``, ``m.room.member`` events are not filtered.
By default, servers should suppress duplicate redundant By default, servers should suppress duplicate redundant
lazy-loaded ``m.room.member`` events from being sent to a given lazy-loaded ``m.room.member`` events from being sent to a given
client across multiple calls to ``/sync``, given that most clients client across multiple calls, given that most clients
cache membership events (see ``include_redundant_members`` cache membership events (see ``include_redundant_members``
to change this behaviour). to change this behaviour).
Only applicable when filtering state events, such as the
``state`` section of a ``/sync`` or ``/messages``.
include_redundant_members: include_redundant_members:
type: boolean type: boolean
description: |- description: |-
If ``true``, the ``state`` section of the ``/sync`` response will If ``true``, response will always contain the ``m.room.member``
always contain the ``m.room.member`` events required to display events required to display the ``sender`` of the timeline events
the ``sender`` of the timeline events in that response, assuming in that response, assuming ``lazy_load_members`` is enabled. This
``lazy_load_members`` is enabled. This means that redundant means that redundant duplicate member events may be returned across
duplicate member events may be returned across multiple calls to multiple calls to. This is useful for naive clients who never track
``/sync``. This is useful for naive clients who never track
membership data. If ``false``, duplicate ``m.room.member`` events membership data. If ``false``, duplicate ``m.room.member`` events
may be suppressed by the server across multiple calls to ``/sync``. may be suppressed by the server across multiple calls. If
If ``lazy_load_members`` is ``false`` this field is ignored. ``lazy_load_members`` is ``false`` this field is ignored.
Only applicable when filtering state events, such as the
``state`` section of a ``/sync`` or ``/messages``.
not_rooms: not_rooms:
description: A list of room IDs to exclude. If this list is absent then no rooms description: A list of room IDs to exclude. If this list is absent then no rooms
are excluded. A matching room will be excluded even if it is listed in the ``'rooms'`` are excluded. A matching room will be excluded even if it is listed in the ``'rooms'``

Loading…
Cancel
Save