Kazv::Api::GetLocalAliasesJob Class Reference

Get a list of local aliases on a given room. More...

#include <directory.hpp>

Inheritance diagram for Kazv::Api::GetLocalAliasesJob:
Collaboration diagram for Kazv::Api::GetLocalAliasesJob:


class  JobResponse

Public Member Functions

 GetLocalAliasesJob (std::string serverUrl, std::string _accessToken, std::string roomId)
 Get a list of local aliases on a given room. More...
GetLocalAliasesJob withData (JsonWrap j) &&
GetLocalAliasesJob withData (JsonWrap j) const &
- Public Member Functions inherited from Kazv::BaseJob
 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< FileDescresponseFile () const

Static Public Member Functions

static constexpr auto needsAuth ()
static BaseJob::Query buildQuery ()
static BaseJob::Body buildBody (std::string roomId)
- Static Public Member Functions inherited from Kazv::BaseJob
static bool contentTypeMatches (immer::array< std::string > expected, std::string actual)

Additional Inherited Members

- Public Types inherited from Kazv::BaseJob
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 Public Attributes inherited from Kazv::BaseJob
static Get GET {}
static Post POST {}
static Put PUT {}
static Delete DELETE {}
- Protected Member Functions inherited from Kazv::BaseJob
void attachData (JsonWrap data)

Detailed Description

Get a list of local aliases on a given room.

Get a list of aliases maintained by the local server for the given room.

This endpoint can be called by users who are in the room (external users receive an M_FORBIDDEN error response). If the room's maps to world_readable, any user can call this endpoint.

Servers may choose to implement additional access control checks here, such as allowing server administrators to view aliases regardless of membership.

Note: Clients are recommended not to display this list of aliases prominently as they are not curated, unlike those listed in the state event.

Constructor & Destructor Documentation

◆ GetLocalAliasesJob()

Kazv::Api::GetLocalAliasesJob::GetLocalAliasesJob ( std::string  serverUrl,
std::string  _accessToken,
std::string  roomId 

Get a list of local aliases on a given room.

roomIdThe room ID to find local aliases of.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::GetLocalAliasesJob::buildBody ( std::string  roomId)

◆ buildQuery()

BaseJob::Query Kazv::Api::GetLocalAliasesJob::buildQuery ( )

◆ needsAuth()

static constexpr auto Kazv::Api::GetLocalAliasesJob::needsAuth ( )

◆ withData() [1/2]

GetLocalAliasesJob Kazv::Api::GetLocalAliasesJob::withData ( JsonWrap  j) &&

◆ withData() [2/2]

GetLocalAliasesJob Kazv::Api::GetLocalAliasesJob::withData ( JsonWrap  j) const &

The documentation for this class was generated from the following files: