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

#include <search.h>

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

QStringList	highlights {}

std::vector< Result >	results {}
	List of results in the requested order.

std::unordered_map< RoomId, StateEvents >	state {}

QHash< QString, QHash< QString, GroupValue > >	groups {}

QString	nextBatch {}

Detailed Description

Mapping of category name to search criteria.

Definition at line 143 of file search.h.

Member Data Documentation

◆ count

std::optional<int> Quotient::SearchJob::ResultRoomEvents::count {}

An approximate count of the total number of results found.

Definition at line 145 of file search.h.

◆ groups

QHash<QString, QHash<QString, GroupValue> > Quotient::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).

Definition at line 167 of file search.h.

◆ highlights

QStringList Quotient::SearchJob::ResultRoomEvents::highlights {}

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

Definition at line 149 of file search.h.

◆ nextBatch

QString Quotient::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.

Definition at line 173 of file search.h.

◆ results

std::vector<Result> Quotient::SearchJob::ResultRoomEvents::results {}

List of results in the requested order.

Definition at line 152 of file search.h.

◆ state

std::unordered_map<RoomId, StateEvents> Quotient::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 key is the room ID for which the State Event array belongs to.

Definition at line 160 of file search.h.

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

Quotient/csapi/search.h

Public Attributes