Set the position of the read marker for a room. More...

Inheritance diagram for Kazv::Api::SetReadMarkerJob:

Collaboration diagram for Kazv::Api::SetReadMarkerJob:

[legend]

Public Member Functions
	SetReadMarkerJob (std::string serverUrl, std::string _accessToken, std::string roomId, std::string mFullyRead, std::optional< std::string > mRead=std::nullopt)
	Set the position of the read marker for a room. More...

SetReadMarkerJob	withData (JsonWrap j) &&

SetReadMarkerJob	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 mFullyRead, std::optional< std::string > mRead)

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

Set the position of the read marker for a room.

Sets the position of the read marker for a given room, and optionally the read receipt's location.

Constructor & Destructor Documentation

Kazv::Api::SetReadMarkerJob::SetReadMarkerJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	roomId,
		std::string	mFullyRead,
		std::optional< std::string >	mRead = `std::nullopt`
	)

explicit

Set the position of the read marker for a room.

Parameters

roomId	The room ID to set the read marker in for the user.
mFullyRead	The event ID the read marker should be located at. The event MUST belong to the room.
mRead	The event ID to set the read receipt location at. This is equivalent to calling `/receipt/m.read/$elsewhere:example.org` and is provided here to save that extra call.

BaseJob::Body Kazv::Api::SetReadMarkerJob::buildBody	(	std::string	roomId,
		std::string	mFullyRead,
		std::optional< std::string >	mRead
	)

static

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

static

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

inlinestaticconstexpr

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

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

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