Stop the requesting user remembering about a particular room. More...

#include <leaving.hpp>

Inheritance diagram for Kazv::Api::ForgetRoomJob:

Collaboration diagram for Kazv::Api::ForgetRoomJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	ForgetRoomJob (std::string serverUrl, std::string _accessToken, std::string roomId)
	Stop the requesting user remembering about a particular room. More...

ForgetRoomJob	withData (JsonWrap j) &&

ForgetRoomJob	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)

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 remembering about a particular room.

This API stops a user remembering about a particular room.

In general, history is a first class citizen in Matrix. After this API is called, however, a user will no longer be able to retrieve history for this room. If all users on a homeserver forget a room, the room is eligible for deletion from that homeserver.

If the user is currently joined to the room, they must leave the room before calling this API.

Constructor & Destructor Documentation

◆ ForgetRoomJob()

Kazv::Api::ForgetRoomJob::ForgetRoomJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	roomId
	)

explicit

Stop the requesting user remembering about a particular room.

Parameters

roomId The room identifier to forget.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::ForgetRoomJob::buildBody ( std::string roomId )

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

ForgetRoomJob Kazv::Api::ForgetRoomJob::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