Kazv::Api::GetEventContextJob::JobResponse Class Reference

#include <event_context.hpp>

Inheritance diagram for Kazv::Api::GetEventContextJob::JobResponse:

Collaboration diagram for Kazv::Api::GetEventContextJob::JobResponse:

Public Member Functions
	JobResponse (Response r)
bool	success () const
std::optional< std::string >	start () const
	A token that can be used to paginate backwards with.
std::optional< std::string >	end () const
	A token that can be used to paginate forwards with.
EventList	eventsBefore () const
	A list of room events that happened just before the requested event, in reverse-chronological order.
JsonWrap	event () const
	Details of the requested event.
EventList	eventsAfter () const
	A list of room events that happened just after the requested event, in chronological order.
EventList	state () const
	The state of the room at the last event returned.
Public Member Functions inherited from Kazv::Response
std::string	errorCode () const
std::string	errorMessage () const
JsonWrap	jsonBody () const
constexpr bool	success () const
json	dataJson (const std::string &key) const
std::string	dataStr (const std::string &key) const
std::string	jobId () const

Additional Inherited Members
Public Types inherited from Kazv::Response
using	StatusCode = int
Public Attributes inherited from Kazv::Response
StatusCode	statusCode
Body	body
Header	header
JsonWrap	extraData

Constructor & Destructor Documentation

JobResponse()

Kazv::Api::GetEventContextJob::JobResponse::JobResponse

(

Response

r

)

Member Function Documentation

end()

std::optional< std::string > Kazv::Api::GetEventContextResponse::end

(

)

const

A token that can be used to paginate forwards with.

event()

JsonWrap Kazv::Api::GetEventContextResponse::event

(

)

const

Details of the requested event.

eventsAfter()

EventList Kazv::Api::GetEventContextResponse::eventsAfter

(

)

const

A list of room events that happened just after the requested event, in chronological order.

eventsBefore()

EventList Kazv::Api::GetEventContextResponse::eventsBefore

(

)

const

A list of room events that happened just before the requested event, in reverse-chronological order.

start()

std::optional< std::string > Kazv::Api::GetEventContextResponse::start

(

)

const

A token that can be used to paginate backwards with.

state()

EventList Kazv::Api::GetEventContextResponse::state

(

)

const

The state of the room at the last event returned.

success()

bool Kazv::Api::GetEventContextResponse::success

(

)

const

---

The documentation for this class was generated from the following files:

• src/api/csapi/event_context.hpp
• src/api/csapi/event_context.cpp