libkazv
|
Lists the public rooms on the server. More...
#include <list_public_rooms.hpp>
Classes | |
class | JobResponse |
Public Member Functions | |
GetPublicRoomsJob (std::string serverUrl, std::optional< int > limit=std::nullopt, std::optional< std::string > since=std::nullopt, std::optional< std::string > server=std::nullopt) | |
Lists the public rooms on the server. More... | |
GetPublicRoomsJob | withData (JsonWrap j) && |
GetPublicRoomsJob | withData (JsonWrap j) const & |
![]() | |
BaseJob (std::string serverUrl, std::string requestUrl, Method method, std::string jobId, std::string token={}, ReturnType returnType=ReturnType::Json, Body body=EmptyBody{}, Query query={}, Header header={}, std::optional< FileDesc > responseFile=std::nullopt) | |
~BaseJob () | |
bool | shouldReturnJson () const |
std::string | url () const |
Body | requestBody () const |
Header | requestHeader () const |
ReturnType | returnType () const |
Query | requestQuery () const |
returns the non-encoded query as an array of pairs More... | |
Method | requestMethod () const |
Response | genResponse (Response r) const |
BaseJob | withData (JsonWrap j) && |
BaseJob | withData (JsonWrap j) const & |
BaseJob | withQueue (std::string id, JobQueuePolicy policy=AlwaysContinue) && |
BaseJob | withQueue (std::string id, JobQueuePolicy policy=AlwaysContinue) const & |
json | dataJson (const std::string &key) const |
std::string | dataStr (const std::string &key) const |
std::string | jobId () const |
std::optional< std::string > | queueId () const |
JobQueuePolicy | queuePolicy () const |
std::optional< FileDesc > | responseFile () const |
Static Public Member Functions | |
static constexpr auto | needsAuth () |
static BaseJob::Query | buildQuery (std::optional< int > limit, std::optional< std::string > since, std::optional< std::string > server) |
static BaseJob::Body | buildBody (std::optional< int > limit, std::optional< std::string > since, std::optional< std::string > server) |
![]() | |
static bool | contentTypeMatches (immer::array< std::string > expected, std::string actual) |
Additional Inherited Members | |
![]() | |
enum | ReturnType { Json, File } |
using | Method = std::variant< Get, Post, Put, Delete > |
using | Body = ::Kazv::Body |
using | BytesBody = ::Kazv::BytesBody |
using | JsonBody = ::Kazv::JsonBody |
using | EmptyBody = ::Kazv::EmptyBody |
using | Header = ::Kazv::Header |
using | Response = ::Kazv::Response |
![]() | |
static Get | GET {} |
static Post | POST {} |
static Put | PUT {} |
static Delete | DELETE {} |
![]() | |
void | attachData (JsonWrap data) |
Lists the public rooms on the server.
Lists the public rooms on the server.
This API returns paginated responses. The rooms are ordered by the number of joined members, with the largest rooms first.
|
explicit |
Lists the public rooms on the server.
limit | Limit the number of results returned. |
since | A pagination token from a previous request, allowing clients to get the next (or previous) batch of rooms. The direction of pagination is specified solely by which token is supplied, rather than via an explicit flag. |
server | The server to fetch the public room lists from. Defaults to the local server. |
|
static |
|
static |
|
inlinestaticconstexpr |
GetPublicRoomsJob Kazv::Api::GetPublicRoomsJob::withData | ( | JsonWrap | j | ) | && |
GetPublicRoomsJob Kazv::Api::GetPublicRoomsJob::withData | ( | JsonWrap | j | ) | const & |