Kazv::Api::GetRelatingEventsWithRelTypeAndEventTypeJob::JobResponse Class Reference
#include <relations.hpp>
Inheritance diagram for Kazv::Api::GetRelatingEventsWithRelTypeAndEventTypeJob::JobResponse:
Collaboration diagram for Kazv::Api::GetRelatingEventsWithRelTypeAndEventTypeJob::JobResponse:
Public Member Functions | |
| JobResponse (Response r) | |
| bool | success () const |
| EventList | chunk () const |
| The child events of the requested event, ordered topologically most-recent first. More... | |
| std::optional< std::string > | nextBatch () const |
| An opaque string representing a pagination token. More... | |
| std::optional< std::string > | prevBatch () const |
| An opaque string representing a pagination token. 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::GetRelatingEventsWithRelTypeAndEventTypeJob::JobResponse::JobResponse | ( | Response | r | ) |
Member Function Documentation
◆ chunk()
| EventList Kazv::Api::GetRelatingEventsWithRelTypeAndEventTypeResponse::chunk | ( | ) | const |
The child events of the requested event, ordered topologically most-recent first.
The events returned will match the relType and eventType supplied in the URL.
◆ nextBatch()
| std::optional< std::string > Kazv::Api::GetRelatingEventsWithRelTypeAndEventTypeResponse::nextBatch | ( | ) | const |
An opaque string representing a pagination token.
The absence of this token means there are no more results to fetch and the client should stop paginating.
◆ prevBatch()
| std::optional< std::string > Kazv::Api::GetRelatingEventsWithRelTypeAndEventTypeResponse::prevBatch | ( | ) | const |
An opaque string representing a pagination token.
The absence of this token means this is the start of the result set, i.e. this is the first batch/page.
◆ success()
| bool Kazv::Api::GetRelatingEventsWithRelTypeAndEventTypeResponse::success | ( | ) | const |
The documentation for this class was generated from the following files:
- src/api/csapi/relations.hpp
- src/api/csapi/relations.cpp
