Add a tag to a room. More...

#include <tags.hpp>

Inheritance diagram for Kazv::Api::SetRoomTagJob:

Collaboration diagram for Kazv::Api::SetRoomTagJob:

[legend]

Public Member Functions
	SetRoomTagJob (std::string serverUrl, std::string _accessToken, std::string userId, std::string roomId, std::string tag, std::optional< float > order=std::nullopt, JsonWrap additionalProperties={})
	Add a tag to a room. More...

SetRoomTagJob	withData (JsonWrap j) &&

SetRoomTagJob	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, std::string tag, std::optional< float > order, JsonWrap additionalProperties)

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

Add a tag to a room.

Add a tag to the room.

Constructor & Destructor Documentation

Kazv::Api::SetRoomTagJob::SetRoomTagJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	userId,
		std::string	roomId,
		std::string	tag,
		std::optional< float >	order = `std::nullopt`,
		JsonWrap	additionalProperties = `{}`
	)

explicit

Add a tag to a room.

Parameters

userId	The id of the user to add a tag for. The access token must be authorized to make requests for this user ID.
roomId	The ID of the room to add a tag to.
tag	The tag to add.
order	A number in a range `[0,1]` describing a relative position of the room under the given tag.
additionalProperties	Add a tag to the room.

BaseJob::Body Kazv::Api::SetRoomTagJob::buildBody	(	std::string	userId,
		std::string	roomId,
		std::string	tag,
		std::optional< float >	order,
		JsonWrap	additionalProperties
	)

static

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

static

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

inlinestaticconstexpr

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

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

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