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

#include <joining.hpp>

Inheritance diagram for Kazv::Api::JoinRoomJob:

Collaboration diagram for Kazv::Api::JoinRoomJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	JoinRoomJob (std::string serverUrl, std::string _accessToken, std::string roomIdOrAlias, immer::array< std::string > serverName={}, std::optional< ThirdPartySigned > thirdPartySigned=std::nullopt, std::optional< std::string > reason=std::nullopt)
	Start the requesting user participating in a particular room. More...

JoinRoomJob	withData (JsonWrap j) &&

JoinRoomJob	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 (immer::array< std::string > serverName)

static BaseJob::Body	buildBody (std::string roomIdOrAlias, immer::array< std::string > serverName, std::optional< ThirdPartySigned > thirdPartySigned, 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

Start the requesting user participating in a particular room.

Note that this API takes either a room ID or alias, unlike /room/{roomId}/join.

This API starts a user participating in a particular room, if that user is allowed to participate in that room. After this call, the client is allowed to see all current state events in the room, and all subsequent events associated with the room until the user leaves the room.

After a user has joined a room, the room will appear as an entry in the response of the /initialSync and /sync APIs.

Constructor & Destructor Documentation

◆ JoinRoomJob()

Kazv::Api::JoinRoomJob::JoinRoomJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	roomIdOrAlias,
		immer::array< std::string >	serverName = `{}`,
		std::optional< ThirdPartySigned >	thirdPartySigned = `std::nullopt`,
		std::optional< std::string >	reason = `std::nullopt`
	)

explicit

Start the requesting user participating in a particular room.

Parameters

roomIdOrAlias	The room identifier or alias to join.
serverName	The servers to attempt to join the room through. One of the servers must be participating in the room.
thirdPartySigned	If a `third_party_signed` was supplied, the homeserver must verify that it matches a pending `m.room.third_party_invite` event in the room, and perform key validity checking if required by the event.
reason	Optional reason to be included as the `reason` on the subsequent membership event.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::JoinRoomJob::buildBody	(	std::string	roomIdOrAlias,
		immer::array< std::string >	serverName,
		std::optional< ThirdPartySigned >	thirdPartySigned,
		std::optional< std::string >	reason
	)

static

◆ buildQuery()

BaseJob::Query Kazv::Api::JoinRoomJob::buildQuery ( immer::array< std::string > serverName )

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/joining.hpp
src/api/csapi/joining.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members