Lists the public rooms on the server. More...

#include <list_public_rooms.h>

Inheritance diagram for Quotient::GetPublicRoomsJob:

Collaboration diagram for Quotient::GetPublicRoomsJob:

Classes
struct	Response

Public Member Functions
	GetPublicRoomsJob (std::optional< int > limit=std::nullopt, const QString &since={}, const QString &server={})

QVector< PublicRoomsChunk >	chunk () const
	A paginated chunk of public rooms. More...

QString	nextBatch () const

QString	prevBatch () const

std::optional< int >	totalRoomCountEstimate () const

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, std::optional< int > limit=std::nullopt, const QString &since={}, const QString &server={})
	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

Lists the public rooms on the server.

This API returns paginated responses. The rooms are ordered by the number of joined members, with the largest rooms first.

Definition at line 62 of file list_public_rooms.h.

Constructor & Destructor Documentation

◆ GetPublicRoomsJob()

Quotient::GetPublicRoomsJob::GetPublicRoomsJob	(	std::optional< int >	limit = `std::nullopt`,
		const QString &	since = `{}`,
		const QString &	server = `{}`
	)

explicit

Parameters

limit	Limit the number of results returned.
since	A pagination token from a previous request, allowing clients to get the next (or previous) batch of rooms. The direction of pagination is specified solely by which token is supplied, rather than via an explicit flag.
server	The server to fetch the public room lists from. Defaults to the local server. Case sensitive.

Member Function Documentation

◆ chunk()

QVector<PublicRoomsChunk> Quotient::GetPublicRoomsJob::chunk ( ) const

inline

A paginated chunk of public rooms.

Definition at line 89 of file list_public_rooms.h.

◆ makeRequestUrl()

static QUrl Quotient::GetPublicRoomsJob::makeRequestUrl	(	const HomeserverData &	hsData,
		std::optional< int >	limit = `std::nullopt`,
		const QString &	since = `{}`,
		const QString &	server = `{}`
	)

static

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

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

◆ nextBatch()

QString Quotient::GetPublicRoomsJob::nextBatch ( ) const

inline

A pagination token for the response. The absence of this token means there are no more results to fetch and the client should stop paginating.

Definition at line 97 of file list_public_rooms.h.

◆ prevBatch()

QString Quotient::GetPublicRoomsJob::prevBatch ( ) const

inline

A pagination token that allows fetching previous results. The absence of this token means there are no results before this batch, i.e. this is the first batch.

Definition at line 102 of file list_public_rooms.h.

◆ totalRoomCountEstimate()

std::optional<int> Quotient::GetPublicRoomsJob::totalRoomCountEstimate ( ) const

inline

An estimate on the total number of public rooms, if the server has an estimate.

Definition at line 106 of file list_public_rooms.h.

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

Quotient/csapi/list_public_rooms.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GetPublicRoomsJob()

Member Function Documentation

◆ chunk()

◆ makeRequestUrl()

◆ nextBatch()

◆ prevBatch()

◆ totalRoomCountEstimate()