libkazv
Kazv::Api::EventFilter Struct Reference

#include <event_filter.hpp>

Inheritance diagram for Kazv::Api::EventFilter:

Public Attributes

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

◆ limit

std::optional<int> Kazv::Api::EventFilter::limit

The maximum number of events to return.

◆ notSenders

immer::array<std::string> Kazv::Api::EventFilter::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.

◆ notTypes

immer::array<std::string> Kazv::Api::EventFilter::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.

◆ senders

immer::array<std::string> Kazv::Api::EventFilter::senders

A list of senders IDs to include. If this list is absent then all senders are included.

◆ types

immer::array<std::string> Kazv::Api::EventFilter::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.


The documentation for this struct was generated from the following file: