Updates a room's visibility in the application service's room directory. More...

#include <appservice_room_directory.hpp>

Inheritance diagram for Kazv::Api::UpdateAppserviceRoomDirectoryVisibilityJob:

Collaboration diagram for Kazv::Api::UpdateAppserviceRoomDirectoryVisibilityJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	UpdateAppserviceRoomDirectoryVisibilityJob (std::string serverUrl, std::string _accessToken, std::string networkId, std::string roomId, std::string visibility)
	Updates a room's visibility in the application service's room directory. More...

UpdateAppserviceRoomDirectoryVisibilityJob	withData (JsonWrap j) &&

UpdateAppserviceRoomDirectoryVisibilityJob	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 networkId, std::string roomId, std::string visibility)

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

Updates a room's visibility in the application service's room directory.

Updates the visibility of a given room on the application service's room directory.

This API is similar to the room directory visibility API used by clients to update the homeserver's more general room directory.

This API requires the use of an application service access token (as_token) instead of a typical client's access_token. This API cannot be invoked by users who are not identified as application services.

Constructor & Destructor Documentation

◆ UpdateAppserviceRoomDirectoryVisibilityJob()

Kazv::Api::UpdateAppserviceRoomDirectoryVisibilityJob::UpdateAppserviceRoomDirectoryVisibilityJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	networkId,
		std::string	roomId,
		std::string	visibility
	)

explicit

Updates a room's visibility in the application service's room directory.

Parameters

networkId	The protocol (network) ID to update the room list for. This would have been provided by the application service as being listed as a supported protocol.
roomId	The room ID to add to the directory.
visibility	Whether the room should be visible (public) in the directory or not (private).

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::UpdateAppserviceRoomDirectoryVisibilityJob::buildBody	(	std::string	networkId,
		std::string	roomId,
		std::string	visibility
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/appservice_room_directory.hpp
src/api/csapi/appservice_room_directory.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members