Get the m.room.member events for the room. More...

#include <rooms.hpp>

Inheritance diagram for Kazv::Api::GetMembersByRoomJob:

Collaboration diagram for Kazv::Api::GetMembersByRoomJob:

[legend]

Public Member Functions
	GetMembersByRoomJob (std::string serverUrl, std::string _accessToken, std::string roomId, std::optional< std::string > at=std::nullopt, std::optional< std::string > membership=std::nullopt, std::optional< std::string > notMembership=std::nullopt)
	Get the m.room.member events for the room. More...

GetMembersByRoomJob	withData (JsonWrap j) &&

GetMembersByRoomJob	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 (std::optional< std::string > at, std::optional< std::string > membership, std::optional< std::string > notMembership)

static BaseJob::Body	buildBody (std::string roomId, std::optional< std::string > at, std::optional< std::string > membership, std::optional< std::string > notMembership)

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

Get the m.room.member events for the room.

Get the list of members for this room.

Constructor & Destructor Documentation

Kazv::Api::GetMembersByRoomJob::GetMembersByRoomJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	roomId,
		std::optional< std::string >	at = `std::nullopt`,
		std::optional< std::string >	membership = `std::nullopt`,
		std::optional< std::string >	notMembership = `std::nullopt`
	)

explicit

Get the m.room.member events for the room.

Parameters

roomId	The room to get the member events for.
at	The point in time (pagination token) to return members for in the room. This token can be obtained from a `prev_batch` token returned for each room by the sync API. Defaults to the current state of the room, as determined by the server.
membership	The kind of membership to filter for. Defaults to no filtering if unspecified. When specified alongside `not_membership`, the two parameters create an 'or' condition: either the membership is the same as `membership` or is not the same as `not_membership`.
notMembership	The kind of membership to exclude from the results. Defaults to no filtering if unspecified.

BaseJob::Body Kazv::Api::GetMembersByRoomJob::buildBody	(	std::string	roomId,
		std::optional< std::string >	at,
		std::optional< std::string >	membership,
		std::optional< std::string >	notMembership
	)

static

BaseJob::Query Kazv::Api::GetMembersByRoomJob::buildQuery	(	std::optional< std::string >	at,
		std::optional< std::string >	membership,
		std::optional< std::string >	notMembership
	)

static

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

inlinestaticconstexpr

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

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

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