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

#include <search.h>

Collaboration diagram for Quotient::SearchJob::RoomEventsCriteria:

Public Attributes
QString	searchTerm
	The string to search events for. More...

QStringList	keys {}
	The keys to search. Defaults to all. More...

RoomEventFilter	filter {}
	This takes a filter. More...

QString	orderBy {}

std::optional< IncludeEventContext >	eventContext {}

std::optional< bool >	includeState {}

std::optional< Groupings >	groupings {}

Detailed Description

Mapping of category name to search criteria.

Definition at line 52 of file search.h.

Member Data Documentation

std::optional<IncludeEventContext> Quotient::SearchJob::RoomEventsCriteria::eventContext {}

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

Definition at line 68 of file search.h.

RoomEventFilter Quotient::SearchJob::RoomEventsCriteria::filter {}

This takes a filter.

Definition at line 60 of file search.h.

std::optional<Groupings> Quotient::SearchJob::RoomEventsCriteria::groupings {}

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

Definition at line 76 of file search.h.

std::optional<bool> Quotient::SearchJob::RoomEventsCriteria::includeState {}

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

Definition at line 72 of file search.h.

QStringList Quotient::SearchJob::RoomEventsCriteria::keys {}

The keys to search. Defaults to all.

Definition at line 57 of file search.h.

QString Quotient::SearchJob::RoomEventsCriteria::orderBy {}

The order in which to search for results. By default, this is "rank".

Definition at line 64 of file search.h.

QString Quotient::SearchJob::RoomEventsCriteria::searchTerm

The string to search events for.

Definition at line 54 of file search.h.

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