Send a receipt for the given event ID. More...

#include <receipts.hpp>

Inheritance diagram for Kazv::Api::PostReceiptJob:

Collaboration diagram for Kazv::Api::PostReceiptJob:

[legend]

Public Member Functions
	PostReceiptJob (std::string serverUrl, std::string _accessToken, std::string roomId, std::string receiptType, std::string eventId, JsonWrap receipt={})
	Send a receipt for the given event ID. More...

PostReceiptJob	withData (JsonWrap j) &&

PostReceiptJob	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 receiptType, std::string eventId, JsonWrap receipt)

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

Send a receipt for the given event ID.

This API updates the marker for the given receipt type to the event ID specified.

Constructor & Destructor Documentation

Kazv::Api::PostReceiptJob::PostReceiptJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	roomId,
		std::string	receiptType,
		std::string	eventId,
		JsonWrap	receipt = `{}`
	)

explicit

Send a receipt for the given event ID.

Parameters

roomId	The room in which to send the event.
receiptType	The type of receipt to send.
eventId	The event ID to acknowledge up to.
receipt	Extra receipt information to attach to `content` if any. The server will automatically set the `ts` field.

BaseJob::Body Kazv::Api::PostReceiptJob::buildBody	(	std::string	roomId,
		std::string	receiptType,
		std::string	eventId,
		JsonWrap	receipt
	)

static

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

static

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

inlinestaticconstexpr

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

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

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