Download content from the content repository overriding the file name. More...

#include <content-repo.h>

Inheritance diagram for Quotient::GetContentOverrideNameJob:

Collaboration diagram for Quotient::GetContentOverrideNameJob:

Public Member Functions
	GetContentOverrideNameJob (const QString &serverName, const QString &mediaId, const QString &fileName, bool allowRemote=true, qint64 timeoutMs=20000, bool allowRedirect=false)

QString	contentType () const
	The content type of the file that was previously uploaded. More...

QString	contentDisposition () const

QIODevice *	data ()
	The content that was previously uploaded. More...

Public Member Functions inherited from Quotient::BaseJob
	BaseJob (HttpVerb verb, const QString &name, QByteArray endpoint, bool needsToken=true)

	BaseJob (HttpVerb verb, const QString &name, QByteArray endpoint, const QUrlQuery &query, RequestData &&data={}, bool needsToken=true)

QUrl	requestUrl () const

bool	isBackground () const

Status	status () const

QString	statusCaption () const

QByteArray	rawData (int bytesAtMost) const

const QByteArray &	rawData () const

QString	rawDataSample (int bytesAtMost=65535) const

QJsonObject	jsonData () const

QJsonArray	jsonItems () const

template<typename T , typename StrT >
T	loadFromJson (const StrT &keyName, T &&defaultValue={}) const

template<typename T >
T	takeFromJson (const QString &key, T &&defaultValue={})

int	error () const

virtual QString	errorString () const

QUrl	errorUrl () const

int	maxRetries () const

void	setMaxRetries (int newMaxRetries)

std::chrono::seconds	getCurrentTimeout () const

Q_INVOKABLE Quotient::BaseJob::duration_ms_t	getCurrentTimeoutMs () const

std::chrono::seconds	getNextRetryInterval () const

Q_INVOKABLE Quotient::BaseJob::duration_ms_t	getNextRetryMs () const

std::chrono::milliseconds	timeToRetry () const

Q_INVOKABLE Quotient::BaseJob::duration_ms_t	millisToRetry () const

Static Public Member Functions
static QUrl	makeRequestUrl (QUrl baseUrl, const QString &serverName, const QString &mediaId, const QString &fileName, bool allowRemote=true, qint64 timeoutMs=20000, bool allowRedirect=false)
	Construct a URL without creating a full-fledged job object. More...

Static Public Member Functions inherited from Quotient::BaseJob
template<typename... StrTs>
static QByteArray	makePath (StrTs &&... parts)

Additional Inherited Members
Public Types inherited from Quotient::BaseJob
enum	StatusCode { Success = 0 , NoError = Success , Pending = 1 , WarningLevel = 20 , UnexpectedResponseType = 21 , UnexpectedResponseTypeWarning = UnexpectedResponseType , Unprepared = 25 , Abandoned = 50 , ErrorLevel = 100 , NetworkError = 101 , Timeout , Unauthorised , ContentAccessError , NotFound , IncorrectRequest , IncorrectResponse , TooManyRequests , RateLimited = TooManyRequests , RequestNotImplemented , UnsupportedRoomVersion , NetworkAuthRequired , UserConsentRequired , CannotLeaveRoom , UserDeactivated , FileError , UserDefinedError = 256 }

using	duration_ms_t = std::chrono::milliseconds::rep

Public Slots inherited from Quotient::BaseJob
void	initiate (Quotient::ConnectionData *connData, bool inBackground)

void	abandon ()
	Abandon the result of this job, arrived or unarrived. More...

Signals inherited from Quotient::BaseJob
void	aboutToSendRequest (QNetworkRequest *req)
	The job is about to send a network request. More...

void	sentRequest ()

void	statusChanged (Quotient::BaseJob::Status newStatus)

void	retryScheduled (int nextAttempt, Quotient::BaseJob::duration_ms_t inMilliseconds)

void	rateLimited ()

void	finished (Quotient::BaseJob *job)

void	result (Quotient::BaseJob *job)

void	success (Quotient::BaseJob *)

void	failure (Quotient::BaseJob *)

void	downloadProgress (qint64 bytesReceived, qint64 bytesTotal)

void	uploadProgress (qint64 bytesSent, qint64 bytesTotal)

Protected Types inherited from Quotient::BaseJob
using	headers_t = QHash< QByteArray, QByteArray >

Protected Slots inherited from Quotient::BaseJob
void	timeout ()

virtual Status	checkReply (const QNetworkReply *reply) const
	Check the pending or received reply for upfront issues. More...

Protected Member Functions inherited from Quotient::BaseJob
const headers_t &	requestHeaders () const

void	setRequestHeader (const headers_t::key_type &headerName, const headers_t::mapped_type &headerValue)

void	setRequestHeaders (const headers_t &headers)

QUrlQuery	query () const

void	setRequestQuery (const QUrlQuery &query)

const RequestData &	requestData () const

void	setRequestData (RequestData &&data)

const QByteArrayList &	expectedContentTypes () const

void	addExpectedContentType (const QByteArray &contentType)

void	setExpectedContentTypes (const QByteArrayList &contentTypes)

QByteArrayList	expectedKeys () const

void	addExpectedKey (const QByteArray &key)

void	setExpectedKeys (const QByteArrayList &keys)

const QNetworkReply *	reply () const

QNetworkReply *	reply ()

virtual void	doPrepare ()

virtual void	onSentRequest (QNetworkReply *)

virtual void	beforeAbandon ()

virtual Status	prepareResult ()
	An extension point for additional reply processing. More...

virtual Status	prepareError (Status currentStatus)
	Process details of the error. More...

QJsonValue	takeValueFromJson (const QString &key)
	Get direct access to the JSON response object in the job. More...

void	setStatus (Status s)

void	setStatus (int code, QString message)

void	setLoggingCategory (QMessageLogger::CategoryFunction lcf)
	Set the logging category for the given job instance. More...

	~BaseJob () override

Static Protected Member Functions inherited from Quotient::BaseJob
static QUrl	makeRequestUrl (QUrl baseUrl, const QByteArray &encodedPath, const QUrlQuery &query={})

Properties inherited from Quotient::BaseJob
QUrl	requestUrl

int	maxRetries

int	statusCode

Detailed Description

Download content from the content repository overriding the file name.

This will download content from the content repository (same as the previous endpoint) but replace the target file name with the one provided by the caller.

Definition at line 163 of file content-repo.h.

Constructor & Destructor Documentation

◆ GetContentOverrideNameJob()

Quotient::GetContentOverrideNameJob::GetContentOverrideNameJob	(	const QString &	serverName,
		const QString &	mediaId,
		const QString &	fileName,
		bool	allowRemote = `true`,
		qint64	timeoutMs = `20000`,
		bool	allowRedirect = `false`
	)

explicit

Parameters

serverName	The server name from the `mxc://` URI (the authoritory component)
mediaId	The media ID from the `mxc://` URI (the path component)
fileName	A filename to give in the `Content-Disposition` header.
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.
timeoutMs	The maximum number of milliseconds that the client is willing to wait to start receiving data, in the case that the content has not yet been uploaded. The default value is 20000 (20 seconds). The content repository can and should impose a maximum value for this parameter. The content repository may also choose to respond before the timeout.
allowRedirect	Indicates to the server that it may return a 307 or 308 redirect response that points at the relevant media content. When not explicitly set to true the server must return the media content itself.

Member Function Documentation

◆ contentDisposition()

QString Quotient::GetContentOverrideNameJob::contentDisposition ( ) const

inline

The fileName requested or the name of the file that was previously uploaded, if set.

Definition at line 210 of file content-repo.h.

◆ contentType()

QString Quotient::GetContentOverrideNameJob::contentType ( ) const

inline

The content type of the file that was previously uploaded.

Definition at line 206 of file content-repo.h.

◆ data()

QIODevice* Quotient::GetContentOverrideNameJob::data ( )

inline

The content that was previously uploaded.

Definition at line 216 of file content-repo.h.

◆ makeRequestUrl()

static QUrl Quotient::GetContentOverrideNameJob::makeRequestUrl	(	QUrl	baseUrl,
		const QString &	serverName,
		const QString &	mediaId,
		const QString &	fileName,
		bool	allowRemote = `true`,
		qint64	timeoutMs = `20000`,
		bool	allowRedirect = `false`
	)

static

Construct a URL without creating a full-fledged job object.

This function can be used when a URL for GetContentOverrideNameJob is necessary but the job itself isn't.

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

Quotient/csapi/content-repo.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GetContentOverrideNameJob()

Member Function Documentation

◆ contentDisposition()

◆ contentType()

◆ data()

◆ makeRequestUrl()