Stop the requesting user participating in a particular room. More...

#include <leaving.hpp>

Inheritance diagram for Kazv::Api::LeaveRoomJob:

Collaboration diagram for Kazv::Api::LeaveRoomJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	LeaveRoomJob (std::string serverUrl, std::string _accessToken, std::string roomId, std::optional< std::string > reason=std::nullopt)
	Stop the requesting user participating in a particular room. More...

LeaveRoomJob	withData (JsonWrap j) &&

LeaveRoomJob	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 > reason)

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

Stop the requesting user participating in a particular room.

This API stops a user participating in a particular room.

If the user was already in the room, they will no longer be able to see new events in the room. If the room requires an invite to join, they will need to be re-invited before they can re-join.

If the user was invited to the room, but had not joined, this call serves to reject the invite.

The user will still be allowed to retrieve history from the room which they were previously allowed to see.

Constructor & Destructor Documentation

◆ LeaveRoomJob()

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

explicit

Stop the requesting user participating in a particular room.

Parameters

roomId	The room identifier to leave.
reason	Optional reason to be included as the `reason` on the subsequent membership event.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::LeaveRoomJob::buildBody	(	std::string	roomId,
		std::optional< std::string >	reason
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/leaving.hpp
src/api/csapi/leaving.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members