#include <message_pagination.hpp>
Public Member Functions | |
| JobResponse (Response r) | |
| bool | success () const |
| std::string | start () const |
A token corresponding to the start of chunk. More... | |
| std::optional< std::string > | end () const |
A token corresponding to the end of chunk. More... | |
| EventList | chunk () const |
| A list of room events. More... | |
| EventList | state () const |
A list of state events relevant to showing the chunk. 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::GetRoomEventsJob::JobResponse::JobResponse | ( | Response | r | ) |
Member Function Documentation
◆ chunk()
| EventList Kazv::Api::GetRoomEventsResponse::chunk | ( | ) | const |
A list of room events.
The order depends on the dir parameter. For dir=b events will be in reverse-chronological order, for dir=f in chronological order. (The exact definition of chronological is dependent on the server implementation.)
Note that an empty chunk does not necessarily imply that no more events are available. Clients should continue to paginate until no end property is returned.
◆ end()
| std::optional< std::string > Kazv::Api::GetRoomEventsResponse::end | ( | ) | const |
A token corresponding to the end of chunk.
This token can be passed back to this endpoint to request further events.
If no further events are available (either because we have reached the start of the timeline, or because the user does not have permission to see any more events), this property is omitted from the response.
◆ start()
| std::string Kazv::Api::GetRoomEventsResponse::start | ( | ) | const |
A token corresponding to the start of chunk.
This will be the same as the value given in from.
◆ state()
| EventList Kazv::Api::GetRoomEventsResponse::state | ( | ) | const |
A list of state events relevant to showing the chunk.
For example, if lazy_load_members is enabled in the filter then this may contain the membership events for the senders of events in the chunk.
Unless include_redundant_members is true, the server may remove membership events which would have already been sent to the client in prior calls to this endpoint, assuming the membership of those members has not changed.
◆ success()
| bool Kazv::Api::GetRoomEventsResponse::success | ( | ) | const |
The documentation for this class was generated from the following files:
- src/api/csapi/message_pagination.hpp
- src/api/csapi/message_pagination.cpp
