Kazv::Api::GetPublicRoomsJob::JobResponse Class Reference
#include <list_public_rooms.hpp>
Inheritance diagram for Kazv::Api::GetPublicRoomsJob::JobResponse:
Collaboration diagram for Kazv::Api::GetPublicRoomsJob::JobResponse:
Public Member Functions | |
| JobResponse (Response r) | |
| bool | success () const |
| immer::array< PublicRoomsChunk > | chunk () const |
| A paginated chunk of public rooms. More... | |
| std::optional< std::string > | nextBatch () const |
| A pagination token for the response. More... | |
| std::optional< std::string > | prevBatch () const |
| A pagination token that allows fetching previous results. More... | |
| std::optional< int > | totalRoomCountEstimate () const |
| An estimate on the total number of public rooms, if the server has an estimate. 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::GetPublicRoomsJob::JobResponse::JobResponse | ( | Response | r | ) |
Member Function Documentation
◆ chunk()
| immer::array< PublicRoomsChunk > Kazv::Api::GetPublicRoomsResponse::chunk | ( | ) | const |
A paginated chunk of public rooms.
◆ nextBatch()
| std::optional< std::string > Kazv::Api::GetPublicRoomsResponse::nextBatch | ( | ) | const |
A pagination token for the response.
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::GetPublicRoomsResponse::prevBatch | ( | ) | const |
A pagination token that allows fetching previous results.
The absence of this token means there are no results before this batch, i.e. this is the first batch.
◆ success()
| bool Kazv::Api::GetPublicRoomsResponse::success | ( | ) | const |
◆ totalRoomCountEstimate()
| std::optional< int > Kazv::Api::GetPublicRoomsResponse::totalRoomCountEstimate | ( | ) | const |
An estimate on the total number of public rooms, if the server has an estimate.
The documentation for this class was generated from the following files:
- src/api/csapi/list_public_rooms.hpp
- src/api/csapi/list_public_rooms.cpp
