#include <room_event_filter.hpp>
Public Attributes | |
| std::optional< bool > | lazyLoadMembers |
If true, enables lazy-loading of membership events. More... | |
| std::optional< bool > | includeRedundantMembers |
If true, sends all membership events for all events, even if they have already been sent to the client. More... | |
| 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. More... | |
| immer::array< std::string > | rooms |
| A list of room IDs to include. If this list is absent then all rooms are included. More... | |
| std::optional< bool > | containsUrl |
If true, includes only events with a url key in their content. If false, excludes those events. If omitted, url key is not considered for filtering. More... | |
 Public Attributes inherited from Kazv::Api::EventFilter | |
| std::optional< int > | limit |
| The maximum number of events to return. More... | |
| immer::array< std::string > | notSenders |
| 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. More... | |
| immer::array< std::string > | notTypes |
| 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 of characters. More... | |
| immer::array< std::string > | senders |
| A list of senders IDs to include. If this list is absent then all senders are included. More... | |
| immer::array< std::string > | types |
| 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 of characters. More... | |
Member Data Documentation
◆ containsUrl
| std::optional<bool> Kazv::Api::RoomEventFilter::containsUrl |
If true, includes only events with a url key in their content. If false, excludes those events. If omitted, url key is not considered for filtering.
◆ includeRedundantMembers
| std::optional<bool> Kazv::Api::RoomEventFilter::includeRedundantMembers |
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 for more information. Defaults to false.
◆ lazyLoadMembers
| std::optional<bool> Kazv::Api::RoomEventFilter::lazyLoadMembers |
If true, enables lazy-loading of membership events.
See Lazy-loading room members for more information. Defaults to false.
◆ notRooms
| immer::array<std::string> Kazv::Api::RoomEventFilter::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.
◆ rooms
| immer::array<std::string> Kazv::Api::RoomEventFilter::rooms |
A list of room IDs to include. If this list is absent then all rooms are included.
The documentation for this struct was generated from the following file:
- src/api/csapi/definitions/room_event_filter.hpp
