libkazv
|
Perform a server-side search. More...
#include <search.hpp>
Classes | |
struct | Categories |
Describes which categories to search in and their criteria. More... | |
struct | EventContext |
Context for result, if requested. More... | |
struct | Group |
Configuration for group. More... | |
struct | Groupings |
Requests that the server partitions the result set based on the provided list of keys. More... | |
struct | GroupValue |
The results for a particular group value. More... | |
struct | IncludeEventContext |
Configures whether any context for the events returned are included in the response. More... | |
class | JobResponse |
struct | Result |
The result object. More... | |
struct | ResultCategories |
Describes which categories to search in and their criteria. More... | |
struct | ResultRoomEvents |
Mapping of category name to search criteria. More... | |
struct | RoomEventsCriteria |
Mapping of category name to search criteria. More... | |
struct | UserProfile |
Performs a full text search across different categories. More... | |
Public Member Functions | |
SearchJob (std::string serverUrl, std::string _accessToken, Categories searchCategories, std::optional< std::string > nextBatch=std::nullopt) | |
Perform a server-side search. More... | |
SearchJob | withData (JsonWrap j) && |
SearchJob | withData (JsonWrap j) const & |
![]() | |
BaseJob (std::string serverUrl, std::string requestUrl, Method method, std::string jobId, std::string token={}, ReturnType returnType=ReturnType::Json, Body body=EmptyBody{}, Query query={}, Header header={}, std::optional< FileDesc > responseFile=std::nullopt) | |
~BaseJob () | |
bool | shouldReturnJson () const |
std::string | url () const |
Body | requestBody () const |
Header | requestHeader () const |
ReturnType | returnType () const |
Query | requestQuery () const |
returns the non-encoded query as an array of pairs More... | |
Method | requestMethod () const |
Response | genResponse (Response r) const |
BaseJob | withData (JsonWrap j) && |
BaseJob | withData (JsonWrap j) const & |
BaseJob | withQueue (std::string id, JobQueuePolicy policy=AlwaysContinue) && |
BaseJob | withQueue (std::string id, JobQueuePolicy policy=AlwaysContinue) const & |
json | dataJson (const std::string &key) const |
std::string | dataStr (const std::string &key) const |
std::string | jobId () const |
std::optional< std::string > | queueId () const |
JobQueuePolicy | queuePolicy () const |
std::optional< FileDesc > | responseFile () const |
Static Public Member Functions | |
static constexpr auto | needsAuth () |
static BaseJob::Query | buildQuery (std::optional< std::string > nextBatch) |
static BaseJob::Body | buildBody (Categories searchCategories, std::optional< std::string > nextBatch) |
![]() | |
static bool | contentTypeMatches (immer::array< std::string > expected, std::string actual) |
Additional Inherited Members | |
![]() | |
enum | ReturnType { Json, File } |
using | Method = std::variant< Get, Post, Put, Delete > |
using | Body = ::Kazv::Body |
using | BytesBody = ::Kazv::BytesBody |
using | JsonBody = ::Kazv::JsonBody |
using | EmptyBody = ::Kazv::EmptyBody |
using | Header = ::Kazv::Header |
using | Response = ::Kazv::Response |
![]() | |
static Get | GET {} |
static Post | POST {} |
static Put | PUT {} |
static Delete | DELETE {} |
![]() | |
void | attachData (JsonWrap data) |
Perform a server-side search.
Performs a full text search across different categories.
|
explicit |
Perform a server-side search.
searchCategories | Describes which categories to search in and their criteria. |
nextBatch | The point to return events from. If given, this should be a next_batch result from a previous call to this endpoint. |
|
static |
|
static |
|
inlinestaticconstexpr |