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

#include <search.hpp>

Public Attributes
std::optional< int >	count
	An approximate count of the total number of results found. More...

immer::array< std::string >	highlights
	List of words which should be highlighted, useful for stemming which may change the query terms. More...

immer::array< Result >	results
	List of results in the requested order. More...

immer::map< std::string, EventList >	state
	The current state for every room in the results. More...

immer::map< std::string, immer::map< std::string, GroupValue > >	groups
	Any groups that were requested. More...

std::optional< std::string >	nextBatch
	Token that can be used to get the next batch of results, by passing as the `next_batch` parameter to the next call. More...

Detailed Description

Mapping of category name to search criteria.

Member Data Documentation

◆ count

std::optional<int> Kazv::Api::SearchJob::ResultRoomEvents::count

An approximate count of the total number of results found.

◆ groups

immer::map<std::string, immer::map<std::string, GroupValue> > Kazv::Api::SearchJob::ResultRoomEvents::groups

Any groups that were requested.

The outer string key is the group key requested (eg: room_id or sender). The inner string key is the grouped value (eg: a room's ID or a user's ID).

◆ highlights

immer::array<std::string> Kazv::Api::SearchJob::ResultRoomEvents::highlights

List of words which should be highlighted, useful for stemming which may change the query terms.

◆ nextBatch

std::optional<std::string> Kazv::Api::SearchJob::ResultRoomEvents::nextBatch

Token that can be used to get the next batch of results, by passing as the next_batch parameter to the next call.

If this field is absent, there are no more results.

◆ results

immer::array<Result> Kazv::Api::SearchJob::ResultRoomEvents::results

List of results in the requested order.

◆ state

immer::map<std::string, EventList> Kazv::Api::SearchJob::ResultRoomEvents::state

The current state for every room in the results.

This is included if the request had the include_state key set with a value of true.

The string key is the room ID for which the State Event array belongs to.

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

src/api/csapi/search.hpp

Public Attributes