Kazv::Api::GetContentJob Class Reference

Download content from the content repository. More...

#include <content-repo.hpp>

Inheritance diagram for Kazv::Api::GetContentJob:

Collaboration diagram for Kazv::Api::GetContentJob:

Classes
class	JobResponse

Public Member Functions
	GetContentJob (std::string serverUrl, std::string serverName, std::string mediaId, bool allowRemote=true, std::optional< FileDesc > downloadTo=std::nullopt)
	Download content from the content repository. More...
GetContentJob	withData (JsonWrap j) &&
GetContentJob	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 (bool allowRemote)
static BaseJob::Body	buildBody (std::string serverName, std::string mediaId, bool allowRemote)
Static Public Member Functions inherited from Kazv::BaseJob
static bool	contentTypeMatches (immer::array< std::string > expected, std::string actual)

Static Public Attributes
static const immer::array< std::string >	expectedContentTypes { "*/*" }
Static Public Attributes inherited from Kazv::BaseJob
static Get	GET {}
static Post	POST {}
static Put	PUT {}
static Delete	DELETE {}

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
Protected Member Functions inherited from Kazv::BaseJob
void	attachData (JsonWrap data)

Detailed Description

Download content from the content repository.

Constructor & Destructor Documentation

GetContentJob()

Kazv::Api::GetContentJob::GetContentJob ( std::string  serverUrl, std::string  serverName, std::string  mediaId, bool  allowRemote = true, std::optional< FileDesc >  downloadTo = std::nullopt  )

explicit

Download content from the content repository.

Parameters

serverName	The server name from the mxc:// URI (the authoritory component)
mediaId	The media ID from the mxc:// URI (the path component)
allowRemote	Indicates to the server that it should not attempt to fetch the media if it is deemed remote. This is to prevent routing loops where the server contacts itself. Defaults to true if not provided.

Member Function Documentation

buildBody()

BaseJob::Body Kazv::Api::GetContentJob::buildBody ( std::string  serverName, std::string  mediaId, bool  allowRemote  )

static

buildQuery()

BaseJob::Query Kazv::Api::GetContentJob::buildQuery ( bool  allowRemote )

static

needsAuth()

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

inlinestaticconstexpr

withData() [1/2]

GetContentJob Kazv::Api::GetContentJob::withData

(

JsonWrap

j

)

&&

withData() [2/2]

GetContentJob Kazv::Api::GetContentJob::withData

(

JsonWrap

j

)

const &

Member Data Documentation

expectedContentTypes

const immer::array< std::string > Kazv::Api::GetContentJob::expectedContentTypes { "*/*" }

static

---

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

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