Download content from the content repository. More...

#include <content-repo.h>

Inheritance diagram for Quotient::GetContentJob:

Collaboration diagram for Quotient::GetContentJob:

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

QString	contentType () const

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
	Current status of the job. More...

QString	statusCaption () const
	Short human-friendly message on the job status. More...

QByteArray	rawData (int bytesAtMost) const
	Get first bytes of the raw response body as received from the server. More...

const QByteArray &	rawData () const
	Access the whole response body as received from the server. More...

QString	rawDataSample (int bytesAtMost=65535) const
	Get UI-friendly sample of raw data. More...

QJsonObject	jsonData () const
	Get the response body as a JSON object. More...

QJsonArray	jsonItems () const
	Get the response body as a JSON array. More...

template<typename T >
T	loadFromJson (auto keyName, T &&defaultValue={}) const
	Load the property from the JSON response assuming a given C++ type. More...

template<typename T >
T	takeFromJson (auto key, T &&defaultValue={})
	Load the property from the JSON response and delete it from JSON. More...

int	error () const
	Error (more generally, status) code. More...

virtual QString	errorString () const
	Error-specific message, as returned by the server. More...

QUrl	errorUrl () const
	A URL to help/clarify the error, if provided by the server. More...

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 (const HomeserverData &hsData, const QString &serverName, const QString &mediaId, 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 (QByteArrayView base, 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 , AccountLocked , UserDefinedError = 256 }
	Job status codes. More...

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 ()
	The job has sent a network request. More...

void	statusChanged (Quotient::BaseJob::Status newStatus)
	The job has changed its status. More...

void	retryScheduled (int nextAttempt, Quotient::BaseJob::duration_ms_t inMilliseconds)
	A retry of the network request is scheduled after the previous request failed. More...

void	rateLimited ()
	The job has been rate-limited. More...

void	finished (Quotient::BaseJob *job)
	The job has finished - either with a result, or abandoned. More...

void	result (Quotient::BaseJob *job)
	The job has finished with a result, successful or unsuccessful. More...

void	success (Quotient::BaseJob *)
	The job has finished with a successful result. More...

void	failure (Quotient::BaseJob *)
	The job has finished with a failure result Emitted together with result() when the job resulted in an error. Mutually exclusive with success(): after result() is emitted, exactly one of success() and failure() will be emitted next. Will not be emitted in case of abandon()ing. More...

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

Protected Member Functions inherited from Quotient::BaseJob
QByteArray	apiEndpoint () const

void	setApiEndpoint (QByteArray apiEndpoint)

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)

QStringList	expectedKeys () const

void	addExpectedKey (QString key)

void	setExpectedKeys (const QStringList &keys)

const QNetworkReply *	reply () const

QNetworkReply *	reply ()

virtual void	doPrepare (const ConnectionData *)
	Prepare the job for execution. More...

virtual void	onSentRequest (QNetworkReply *)
	Postprocessing after the network request has been sent. More...

virtual void	beforeAbandon ()

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

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

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

QJsonValue	takeValueFromJson (QAnyStringView key)
	Retrieve a value for one specific key and delete it from the JSON response object. More...

void	setStatus (Status s)

void	setStatus (int code, QString message)

void	forceResult (QJsonDocument resultDoc, Status s={ Success })
	Force completion of the job for sake of testing. More...

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 (const HomeserverData &hsData, const QByteArray &encodedPath, const QUrlQuery &query={})
	Construct a URL out of baseUrl, path and query. More...

Properties inherited from Quotient::BaseJob
QUrl	requestUrl

int	maxRetries

int	statusCode

Detailed Description

Download content from the content repository.

Note: Replaced by GET /_matrix/client/v1/media/download/{serverName}/{mediaId} (requires authentication).

Warning: [Changed in v1.11] This endpoint MAY return 404 M_NOT_FOUND for media which exists, but is after the server froze unauthenticated media access. See Client Behaviour for more information.

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

Constructor & Destructor Documentation

◆ GetContentJob()

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

explicit

Parameters

serverName	The server name from the `mxc://` URI (the authority 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.

Parameters

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 SHOULD impose a maximum value for this parameter. The content repository MAY 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::GetContentJob::contentDisposition ( ) const

inline

The disposition of the returned content. MUST be one of inline or attachment, and SHOULD contain a file name.

If the Content-Type is allowed in the restrictions for serving inline content, servers SHOULD use inline, otherwise they SHOULD use attachment.

If the upload was made with a filename, this header MUST contain the same filename. Otherwise, filename is excluded from the header. If the media being downloaded is remote, the remote server's filename in the Content-Disposition header is used as the filename instead. When the header is not supplied, or does not supply a filename, the local download response does not include a filename.

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

◆ contentType()

QString Quotient::GetContentJob::contentType ( ) const

inline

The content type of the file that was previously uploaded.

The server MUST return a Content-Type which is either exactly the same as the original upload, or reasonably close. The bounds of "reasonable" are:

Adding a charset to text/* content types.
Detecting HTML and using text/html instead of text/plain.
Using application/octet-stream when the server determines the content type is obviously wrong. For example, an encrypted file being claimed as image/png.
Returning application/octet-stream when the media has an unknown/unprovided Content-Type. For example, being uploaded before the server tracked content types or when the remote server is non-compliantly omitting the header entirely.

Actions not in the spirit of the above are not considered "reasonable".

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

◆ data()

QIODevice* Quotient::GetContentJob::data ( )

inline

The content that was previously uploaded.

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

◆ makeRequestUrl()

static QUrl Quotient::GetContentJob::makeRequestUrl	(	const HomeserverData &	hsData,
		const QString &	serverName,
		const QString &	mediaId,
		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 GetContentJob 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

◆ GetContentJob()

Member Function Documentation

◆ contentDisposition()

◆ contentType()

◆ data()

◆ makeRequestUrl()