Filters to be applied to room data. More...
#include <sync_filter.hpp>
Public Attributes | |
| immer::array< std::string > | notRooms |
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 inephemeral,state,timelineoraccount_data`. More... | |
| immer::array< std::string > | rooms |
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 More... | |
| RoomEventFilter | ephemeral |
| The events that aren't recorded in the room history, e.g. typing and receipts, to include for rooms. More... | |
| std::optional< bool > | includeLeave |
| Include rooms that the user has left in the sync, default false. More... | |
| RoomEventFilter | state |
| The state events to include for rooms. More... | |
| RoomEventFilter | timeline |
| The message and state update events to include for rooms. More... | |
| RoomEventFilter | accountData |
| The per user account data to include for rooms. More... | |
Detailed Description
Filters to be applied to room data.
Member Data Documentation
◆ accountData
| RoomEventFilter Kazv::Api::RoomFilter::accountData |
The per user account data to include for rooms.
◆ ephemeral
| RoomEventFilter Kazv::Api::RoomFilter::ephemeral |
The events that aren't recorded in the room history, e.g. typing and receipts, to include for rooms.
◆ includeLeave
| std::optional<bool> Kazv::Api::RoomFilter::includeLeave |
Include rooms that the user has left in the sync, default false.
◆ notRooms
| immer::array<std::string> Kazv::Api::RoomFilter::notRooms |
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 inephemeral,state,timelineoraccount_data`.
◆ rooms
| immer::array<std::string> Kazv::Api::RoomFilter::rooms |
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
◆ state
| RoomEventFilter Kazv::Api::RoomFilter::state |
The state events to include for rooms.
◆ timeline
| RoomEventFilter Kazv::Api::RoomFilter::timeline |
The message and state update events to include for rooms.
The documentation for this struct was generated from the following file:
- src/api/csapi/definitions/sync_filter.hpp
