Gets the list of currently joined users and their profile data. More...

#include <rooms.hpp>

Inheritance diagram for Kazv::Api::GetJoinedMembersByRoomJob:

Collaboration diagram for Kazv::Api::GetJoinedMembersByRoomJob:

[legend]

Classes
class	JobResponse

struct	RoomMember
	This API returns a map of MXIDs to member info objects for members of the room. The current user must be in the room for it to work, unless it is an Application Service in which case any of the AS's users must be in the room. This API is primarily for Application Services and should be faster to respond than `/members` as it can be implemented more efficiently on the server. More...

Public Member Functions
	GetJoinedMembersByRoomJob (std::string serverUrl, std::string _accessToken, std::string roomId)
	Gets the list of currently joined users and their profile data. More...

GetJoinedMembersByRoomJob	withData (JsonWrap j) &&

GetJoinedMembersByRoomJob	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

Gets the list of currently joined users and their profile data.

This API returns a map of MXIDs to member info objects for members of the room. The current user must be in the room for it to work, unless it is an Application Service in which case any of the AS's users must be in the room. This API is primarily for Application Services and should be faster to respond than /members as it can be implemented more efficiently on the server.

Constructor & Destructor Documentation

◆ GetJoinedMembersByRoomJob()

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

explicit

Gets the list of currently joined users and their profile data.

Parameters

roomId The room to get the members of.

Member Function Documentation

◆ buildBody()

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

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/rooms.hpp
src/api/csapi/rooms.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members