Remove a mapping of room alias to room ID. More...

#include <directory.hpp>

Inheritance diagram for Kazv::Api::DeleteRoomAliasJob:

Collaboration diagram for Kazv::Api::DeleteRoomAliasJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	DeleteRoomAliasJob (std::string serverUrl, std::string _accessToken, std::string roomAlias)
	Remove a mapping of room alias to room ID. More...

DeleteRoomAliasJob	withData (JsonWrap j) &&

DeleteRoomAliasJob	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< FileDesc >	responseFile () const

Static Public Member Functions
static constexpr auto	needsAuth ()

static BaseJob::Query	buildQuery ()

static BaseJob::Body	buildBody (std::string roomAlias)

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

Remove a mapping of room alias to room ID.

Servers may choose to implement additional access control checks here, for instance that room aliases can only be deleted by their creator or a server administrator.

Note: Servers may choose to update the alt_aliases for the m.room.canonical_alias state event in the room when an alias is removed. Servers which choose to update the canonical alias event are recommended to, in addition to their other relevant permission checks, delete the alias and return a successful response even if the user does not have permission to update the m.room.canonical_alias event.

Constructor & Destructor Documentation

◆ DeleteRoomAliasJob()

Kazv::Api::DeleteRoomAliasJob::DeleteRoomAliasJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	roomAlias
	)

explicit

Remove a mapping of room alias to room ID.

Parameters

roomAlias The room alias to remove.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::DeleteRoomAliasJob::buildBody ( std::string roomAlias )

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/directory.hpp
src/api/csapi/directory.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members