Set the user's display name. More...

#include <profile.hpp>

Inheritance diagram for Kazv::Api::SetDisplayNameJob:

Collaboration diagram for Kazv::Api::SetDisplayNameJob:

[legend]

Public Member Functions
	SetDisplayNameJob (std::string serverUrl, std::string _accessToken, std::string userId, std::optional< std::string > displayname=std::nullopt)
	Set the user's display name. More...

SetDisplayNameJob	withData (JsonWrap j) &&

SetDisplayNameJob	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::optional< std::string > displayname)

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 user's display name.

This API sets the given user's display name. You must have permission to set this user's display name, e.g. you need to have their access_token.

Constructor & Destructor Documentation

Kazv::Api::SetDisplayNameJob::SetDisplayNameJob	(	std::string	serverUrl,
		std::string	_accessToken,
		std::string	userId,
		std::optional< std::string >	displayname = `std::nullopt`
	)

explicit

Set the user's display name.

Parameters

userId	The user whose display name to set.
displayname	The new display name for this user.

BaseJob::Body Kazv::Api::SetDisplayNameJob::buildBody	(	std::string	userId,
		std::optional< std::string >	displayname
	)

static

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

static

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

inlinestaticconstexpr

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

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

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