Get the configuration for the content repository. More...

#include <content-repo.hpp>

Inheritance diagram for Kazv::Api::GetConfigJob:

Collaboration diagram for Kazv::Api::GetConfigJob:

[legend]

Classes
class	JobResponse

Public Member Functions
	GetConfigJob (std::string serverUrl, std::string _accessToken)
	Get the configuration for the content repository. More...

GetConfigJob	withData (JsonWrap j) &&

GetConfigJob	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 ()

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

Get the configuration for the content repository.

This endpoint allows clients to retrieve the configuration of the content repository, such as upload limitations. Clients SHOULD use this as a guide when using content repository endpoints. All values are intentionally left optional. Clients SHOULD follow the advice given in the field description when the field is not available.

NOTE: Both clients and server administrators should be aware that proxies between the client and the server may affect the apparent behaviour of content repository APIs, for example, proxies may enforce a lower upload size limit than is advertised by the server on this endpoint.

Constructor & Destructor Documentation

◆ GetConfigJob()

Kazv::Api::GetConfigJob::GetConfigJob	(	std::string	serverUrl,
		std::string	_accessToken
	)

explicit

Get the configuration for the content repository.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::GetConfigJob::buildBody ( )

static

◆ buildQuery()

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

static

◆ needsAuth()

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

inlinestaticconstexpr

◆ withData() [1/2]

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

◆ withData() [2/2]

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

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

src/api/csapi/content-repo.hpp
src/api/csapi/content-repo.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members