Kazv::Api::SearchJob::IncludeEventContext Struct Reference

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

#include <search.hpp>

Public Attributes
std::optional< int >	beforeLimit
	How many events before the result are returned. More...
std::optional< int >	afterLimit
	How many events after the result are returned. More...
std::optional< bool >	includeProfile
	Requests that the server returns the historic profile information for the users that sent the events that were returned. More...

Detailed Description

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

Member Data Documentation

afterLimit

std::optional<int> Kazv::Api::SearchJob::IncludeEventContext::afterLimit

How many events after the result are returned.

By default, this is 5.

beforeLimit

std::optional<int> Kazv::Api::SearchJob::IncludeEventContext::beforeLimit

How many events before the result are returned.

By default, this is 5.

includeProfile

std::optional<bool> Kazv::Api::SearchJob::IncludeEventContext::includeProfile

Requests that the server returns the historic profile information for the users that sent the events that were returned.

By default, this is false.

---

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

• src/api/csapi/search.hpp