Informs the server that the user has started or stopped typing. More...

#include <typing.hpp>

Inheritance diagram for Kazv::Api::SetTypingJob:

Collaboration diagram for Kazv::Api::SetTypingJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	SetTypingJob (std::string serverUrl, std::string _accessToken, std::string userId, std::string roomId, bool typing, std::optional< int > timeout=std::nullopt)
	Informs the server that the user has started or stopped typing. More...

SetTypingJob	withData (JsonWrap j) &&

SetTypingJob	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 userId, std::string roomId, bool typing, std::optional< int > timeout)

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

Informs the server that the user has started or stopped typing.

This tells the server that the user is typing for the next N milliseconds where N is the value specified in the timeout key. Alternatively, if typing is false, it tells the server that the user has stopped typing.

Constructor & Destructor Documentation

◆ SetTypingJob()

Kazv::Api::SetTypingJob::SetTypingJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	userId,
		std::string	roomId,
		bool	typing,
		std::optional< int >	timeout = `std::nullopt`
	)

explicit

Informs the server that the user has started or stopped typing.

Parameters

userId	The user who has started to type.
roomId	The room in which the user is typing.
typing	Whether the user is typing or not. If `false`, the `timeout` key can be omitted.
timeout	The length of time in milliseconds to mark this user as typing.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::SetTypingJob::buildBody	(	std::string	userId,
		std::string	roomId,
		bool	typing,
		std::optional< int >	timeout
	)

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/typing.hpp
src/api/csapi/typing.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members