Kazv::Api::SearchJob::RoomEventsCriteria Struct Reference

Mapping of category name to search criteria. More...

#include <search.hpp>

Collaboration diagram for Kazv::Api::SearchJob::RoomEventsCriteria:

Public Attributes
std::string	searchTerm
	The string to search events for.
immer::array< std::string >	keys
	The keys to search. Defaults to all.
RoomEventFilter	filter
	This takes a filter.
std::optional< std::string >	orderBy
	The order in which to search for results.
std::optional< IncludeEventContext >	eventContext
	Configures whether any context for the events returned are included in the response.
std::optional< bool >	includeState
	Requests the server return the current state for each room returned.
std::optional< Groupings >	groupings
	Requests that the server partitions the result set based on the provided list of keys.

Detailed Description

Mapping of category name to search criteria.

Member Data Documentation

eventContext

std::optional<IncludeEventContext> Kazv::Api::SearchJob::RoomEventsCriteria::eventContext

Configures whether any context for the events returned are included in the response.

filter

RoomEventFilter Kazv::Api::SearchJob::RoomEventsCriteria::filter

This takes a filter.

groupings

std::optional<Groupings> Kazv::Api::SearchJob::RoomEventsCriteria::groupings

Requests that the server partitions the result set based on the provided list of keys.

includeState

std::optional<bool> Kazv::Api::SearchJob::RoomEventsCriteria::includeState

Requests the server return the current state for each room returned.

keys

immer::array<std::string> Kazv::Api::SearchJob::RoomEventsCriteria::keys

The keys to search. Defaults to all.

orderBy

std::optional<std::string> Kazv::Api::SearchJob::RoomEventsCriteria::orderBy

The order in which to search for results.

By default, this is "rank".

searchTerm

std::string Kazv::Api::SearchJob::RoomEventsCriteria::searchTerm

The string to search events for.

---

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

• src/api/csapi/search.hpp