#include <sync_filter.hpp>

Collaboration diagram for Kazv::Api::Filter:

[legend]

Public Attributes
immer::array< std::string >	eventFields
	List of event fields to include. If this list is absent then all fields are included. The entries may include '.' characters to indicate sub-fields. So ['content.body'] will include the 'body' field of the 'content' object. A literal '.' character in a field name may be escaped using a '\'. A server may include more fields than were requested. More...

std::optional< std::string >	eventFormat
	The format to use for events. 'client' will return the events in a format suitable for clients. 'federation' will return the raw event as received over federation. The default is 'client'. More...

EventFilter	presence
	The presence updates to include. More...

EventFilter	accountData
	The user account data that isn't associated with rooms to include. More...

RoomFilter	room
	Filters to be applied to room data. More...

Member Data Documentation

◆ accountData

EventFilter Kazv::Api::Filter::accountData

The user account data that isn't associated with rooms to include.

◆ eventFields

immer::array<std::string> Kazv::Api::Filter::eventFields

List of event fields to include. If this list is absent then all fields are included. The entries may include '.' characters to indicate sub-fields. So ['content.body'] will include the 'body' field of the 'content' object. A literal '.' character in a field name may be escaped using a '\'. A server may include more fields than were requested.

◆ eventFormat

std::optional<std::string> Kazv::Api::Filter::eventFormat

The format to use for events. 'client' will return the events in a format suitable for clients. 'federation' will return the raw event as received over federation. The default is 'client'.

◆ presence

EventFilter Kazv::Api::Filter::presence

The presence updates to include.

◆ room

RoomFilter Kazv::Api::Filter::room

Filters to be applied to room data.

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