libkazv
Kazv::Api::PeekEventsJob::JobResponse Class Reference

#include <peeking_events.hpp>

Inheritance diagram for Kazv::Api::PeekEventsJob::JobResponse:
Collaboration diagram for Kazv::Api::PeekEventsJob::JobResponse:

Public Member Functions

 JobResponse (Response r)
 
bool success () const
 
std::optional< std::string > start () const
 A token which correlates to the first value in chunk. More...
 
std::optional< std::string > end () const
 A token which correlates to the last value in chunk. More...
 
EventList chunk () const
 An array of events. More...
 
- 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::PeekEventsJob::JobResponse::JobResponse ( Response  r)

Member Function Documentation

◆ chunk()

EventList Kazv::Api::PeekEventsResponse::chunk ( ) const

An array of events.

◆ end()

std::optional< std::string > Kazv::Api::PeekEventsResponse::end ( ) const

A token which correlates to the last value in chunk.

This token should be used in the next request to /events.

◆ start()

std::optional< std::string > Kazv::Api::PeekEventsResponse::start ( ) const

A token which correlates to the first value in chunk.

This is usually the same token supplied to from=.

◆ success()

bool Kazv::Api::PeekEventsResponse::success ( ) const

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