Send a message event to the given room. More...

#include <room_send.hpp>

Inheritance diagram for Kazv::Api::SendMessageJob:

Collaboration diagram for Kazv::Api::SendMessageJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	SendMessageJob (std::string serverUrl, std::string _accessToken, std::string roomId, std::string eventType, std::string txnId, JsonWrap body={})
	Send a message event to the given room. More...

SendMessageJob	withData (JsonWrap j) &&

SendMessageJob	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 eventType, std::string txnId, JsonWrap body)

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 message event to the given room.

This endpoint is used to send a message event to a room. Message events allow access to historical events and pagination, making them suited for "once-off" activity in a room.

The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event. See Room Events for the m. event specification.

Constructor & Destructor Documentation

◆ SendMessageJob()

Kazv::Api::SendMessageJob::SendMessageJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	roomId,
		std::string	eventType,
		std::string	txnId,
		JsonWrap	body = `{}`
	)

explicit

Send a message event to the given room.

Parameters

roomId	The room to send the event to.
eventType	The type of event to send.
txnId	The transaction ID for this event. Clients should generate an ID unique across requests with the same access token; it will be used by the server to ensure idempotency of requests.
body	This endpoint is used to send a message event to a room. Message events allow access to historical events and pagination, making them suited for "once-off" activity in a room.

The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event. See Room Events for the m. event specification.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::SendMessageJob::buildBody	(	std::string	roomId,
		std::string	eventType,
		std::string	txnId,
		JsonWrap	body
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/room_send.hpp
src/api/csapi/room_send.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members