Kazv::Api::RoomInitialSyncJob::JobResponse Class Reference
#include <room_initial_sync.hpp>
Inheritance diagram for Kazv::Api::RoomInitialSyncJob::JobResponse:
Collaboration diagram for Kazv::Api::RoomInitialSyncJob::JobResponse:
Public Member Functions | |
| JobResponse (Response r) | |
| bool | success () const |
| std::string | roomId () const |
| The ID of this room. More... | |
| std::optional< std::string > | membership () const |
| The user's membership state in this room. More... | |
| std::optional< PaginationChunk > | messages () const |
| The pagination chunk for this room. More... | |
| EventList | state () const |
| If the user is a member of the room this will be the current state of the room as a list of events. More... | |
| std::optional< std::string > | visibility () const |
Whether this room is visible to the /publicRooms API or not. More... | |
| EventList | accountData () const |
| The private data that this user has attached to this room. 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::RoomInitialSyncJob::JobResponse::JobResponse | ( | Response | r | ) |
Member Function Documentation
◆ accountData()
| EventList Kazv::Api::RoomInitialSyncResponse::accountData | ( | ) | const |
The private data that this user has attached to this room.
◆ membership()
| std::optional< std::string > Kazv::Api::RoomInitialSyncResponse::membership | ( | ) | const |
The user's membership state in this room.
◆ messages()
| std::optional< RoomInitialSyncJob::PaginationChunk > Kazv::Api::RoomInitialSyncResponse::messages | ( | ) | const |
The pagination chunk for this room.
◆ roomId()
| std::string Kazv::Api::RoomInitialSyncResponse::roomId | ( | ) | const |
The ID of this room.
◆ state()
| EventList Kazv::Api::RoomInitialSyncResponse::state | ( | ) | const |
If the user is a member of the room this will be the current state of the room as a list of events.
If the user has left the room this will be the state of the room when they left it.
◆ success()
| bool Kazv::Api::RoomInitialSyncResponse::success | ( | ) | const |
◆ visibility()
| std::optional< std::string > Kazv::Api::RoomInitialSyncResponse::visibility | ( | ) | const |
Whether this room is visible to the /publicRooms API or not.
"
The documentation for this class was generated from the following files:
- src/api/csapi/room_initial_sync.hpp
- src/api/csapi/room_initial_sync.cpp
