Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-02 14:08:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #246 from matrix-org/markjh/room_filter

Browse source 
Add top level filters for filtering by room id.
This commit is contained in:
Mark Haines 2015-12-23 10:45:37 +00:00
parent c9ecfa7643 4c43939977
commit f648360f5d
3 changed files with 19 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
api/client-server/definitions/event_filter.yaml
View file

@ -5,14 +5,14 @@ properties:
not_senders:
description: A list of sender IDs to exclude. If this list is absent then no senders
are excluded. A matching sender will be excluded even if it is listed in the
'senders' filter.
``'senders'`` filter.
items:
type: string
type: array
not_types:
description: A list of event types to exclude. If this list is absent then no
event types are excluded. A matching type will be excluded even if it is listed
in the 'types' filter. A '*' can be used as a wildcard to match any sequence
in the ``'types'`` filter. A '*' can be used as a wildcard to match any sequence
of characters.
items:
type: string
@ -25,7 +25,7 @@ properties:
type: array
types:
description: A list of event types to include. If this list is absent then all
event types are included. A '*' can be used as a wildcard to match any sequence
event types are included. A ``'*'`` can be used as a wildcard to match any sequence
of characters.
items:
type: string

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

@ -3,7 +3,7 @@ allOf:
properties:
not_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.
items:
type: string

15
api/client-server/definitions/sync_filter.yaml
View file

@ -26,6 +26,21 @@ properties:
description: The user account data that isn't associated with rooms to include.
room:
properties:
not_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'``
filter. This filter is applied before the filters in ``ephemeral``,
``state``, ``timeline`` or ``account_data``
items:
type: string
type: array
rooms:
description: A list of room IDs to include. If this list is absent then all rooms
are included. This filter is applied before the filters in ``ephemeral``,
``state``, ``timeline`` or ``account_data``
items:
type: string
type: array
ephemeral:
allOf:
- $ref: room_event_filter.yaml