Ban a user in the room. More...

#include <banning.hpp>

Inheritance diagram for Kazv::Api::BanJob:

Collaboration diagram for Kazv::Api::BanJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	BanJob (std::string serverUrl, std::string _accessToken, std::string roomId, std::string userId, std::optional< std::string > reason=std::nullopt)
	Ban a user in the room. More...

BanJob	withData (JsonWrap j) &&

BanJob	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::string userId, 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

Ban a user in the room.

Ban a user in the room. If the user is currently in the room, also kick them.

When a user is banned from a room, they may not join it or be invited to it until they are unbanned.

The caller must have the required power level in order to perform this operation.

Constructor & Destructor Documentation

◆ BanJob()

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

explicit

Ban a user in the room.

Parameters

roomId	The room identifier (not alias) from which the user should be banned.
userId	The fully qualified user ID of the user being banned.
reason	The reason the user has been banned. This will be supplied as the `reason` on the target's updated `m.room.member` event.

Member Function Documentation

◆ buildBody()

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

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/banning.hpp
src/api/csapi/banning.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members