mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-02-14 10:03:42 +01:00
Move lazy loading filter options to event filter
The options also work on /messages
This commit is contained in:
parent
9e31aed6c7
commit
e7ed8a23ce
|
|
@ -16,6 +16,31 @@ allOf:
|
||||||
- type: object
|
- type: object
|
||||||
title: RoomEventFilter
|
title: RoomEventFilter
|
||||||
properties:
|
properties:
|
||||||
|
lazy_load_members:
|
||||||
|
type: boolean
|
||||||
|
description: |-
|
||||||
|
If ``true``, the only ``m.room.member`` events returned in
|
||||||
|
the ``state`` section of the ``/sync`` response are those
|
||||||
|
which are definitely necessary for a client to display
|
||||||
|
the ``sender`` of the timeline events in that response.
|
||||||
|
If ``false``, ``m.room.member`` events are not filtered.
|
||||||
|
By default, servers should suppress duplicate redundant
|
||||||
|
lazy-loaded ``m.room.member`` events from being sent to a given
|
||||||
|
client across multiple calls to ``/sync``, given that most clients
|
||||||
|
cache membership events (see ``include_redundant_members``
|
||||||
|
to change this behaviour).
|
||||||
|
include_redundant_members:
|
||||||
|
type: boolean
|
||||||
|
description: |-
|
||||||
|
If ``true``, the ``state`` section of the ``/sync`` response will
|
||||||
|
always contain the ``m.room.member`` events required to display
|
||||||
|
the ``sender`` of the timeline events in that response, assuming
|
||||||
|
``lazy_load_members`` is enabled. This means that redundant
|
||||||
|
duplicate member events may be returned across multiple calls to
|
||||||
|
``/sync``. This is useful for naive clients who never track
|
||||||
|
membership data. If ``false``, duplicate ``m.room.member`` events
|
||||||
|
may be suppressed by the server across multiple calls to ``/sync``.
|
||||||
|
If ``lazy_load_members`` is ``false`` this field is ignored.
|
||||||
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'``
|
||||||
|
|
|
||||||
|
|
@ -47,7 +47,7 @@ properties:
|
||||||
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'``
|
||||||
filter. This filter is applied before the filters in ``ephemeral``,
|
filter. This filter is applied before the filters in ``ephemeral``,
|
||||||
``state``, ``timeline`` or ``account_data``
|
``state``, ``timeline`` or ``account_data``
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
|
@ -73,33 +73,6 @@ properties:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: room_event_filter.yaml
|
- $ref: room_event_filter.yaml
|
||||||
description: The state events to include for rooms.
|
description: The state events to include for rooms.
|
||||||
properties:
|
|
||||||
lazy_load_members:
|
|
||||||
type: boolean
|
|
||||||
description: |-
|
|
||||||
If ``true``, the only ``m.room.member`` events returned in
|
|
||||||
the ``state`` section of the ``/sync`` response are those
|
|
||||||
which are definitely necessary for a client to display
|
|
||||||
the ``sender`` of the timeline events in that response.
|
|
||||||
If ``false``, ``m.room.member`` events are not filtered.
|
|
||||||
By default, servers should suppress duplicate redundant
|
|
||||||
lazy-loaded ``m.room.member`` events from being sent to a given
|
|
||||||
client across multiple calls to ``/sync``, given that most clients
|
|
||||||
cache membership events (see ``include_redundant_members``
|
|
||||||
to change this behaviour).
|
|
||||||
include_redundant_members:
|
|
||||||
type: boolean
|
|
||||||
description: |-
|
|
||||||
If ``true``, the ``state`` section of the ``/sync`` response will
|
|
||||||
always contain the ``m.room.member`` events required to display
|
|
||||||
the ``sender`` of the timeline events in that response, assuming
|
|
||||||
``lazy_load_members`` is enabled. This means that redundant
|
|
||||||
duplicate member events may be returned across multiple calls to
|
|
||||||
``/sync``. This is useful for naive clients who never track
|
|
||||||
membership data. If ``false``, duplicate ``m.room.member`` events
|
|
||||||
may be suppressed by the server across multiple calls to ``/sync``.
|
|
||||||
If ``lazy_load_members`` is ``false`` this field is ignored.
|
|
||||||
|
|
||||||
timeline:
|
timeline:
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: room_event_filter.yaml
|
- $ref: room_event_filter.yaml
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue