Sets the visibility of a room in the room directory. More...

#include <list_public_rooms.hpp>

Inheritance diagram for Kazv::Api::SetRoomVisibilityOnDirectoryJob:

Collaboration diagram for Kazv::Api::SetRoomVisibilityOnDirectoryJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	SetRoomVisibilityOnDirectoryJob (std::string serverUrl, std::string _accessToken, std::string roomId, std::optional< std::string > visibility=std::nullopt)
	Sets the visibility of a room in the room directory. More...

SetRoomVisibilityOnDirectoryJob	withData (JsonWrap j) &&

SetRoomVisibilityOnDirectoryJob	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 roomId, std::optional< 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

Sets the visibility of a room in the room directory.

Sets the visibility of a given room in the server's public room directory.

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

Constructor & Destructor Documentation

◆ SetRoomVisibilityOnDirectoryJob()

Kazv::Api::SetRoomVisibilityOnDirectoryJob::SetRoomVisibilityOnDirectoryJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	roomId,
		std::optional< std::string >	visibility = `std::nullopt`
	)

explicit

Sets the visibility of a room in the room directory.

Parameters

roomId	The room ID.
visibility	The new visibility setting for the room. Defaults to 'public'.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::SetRoomVisibilityOnDirectoryJob::buildBody	(	std::string	roomId,
		std::optional< std::string >	visibility
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/list_public_rooms.hpp
src/api/csapi/list_public_rooms.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members