Exception base class for API exceptions. More...

Inheritance diagram for QgsServerApiException:

[legend]

Public Member Functions
	QgsServerApiException (const QString &code, const QString &message, const QString &mimeType=QStringLiteral("application/json"), int responseCode=200)
	Construction.
QByteArray	formatResponse (QString &responseFormat) const override
	Formats the exception for sending to client.
Public Member Functions inherited from QgsServerException
	QgsServerException (const QString &message, int responseCode=500)
	Constructor.
int	responseCode () const
	Returns the return HTTP response code associated with this exception.
Public Member Functions inherited from QgsException
	QgsException (const QString &message)
	Constructor for QgsException, with the specified error message.
virtual	~QgsException () throw () =default
QString	what () const throw ()

Detailed Description

Exception base class for API exceptions.

Note that this exception is associated with a default return code 200 which may be not appropriate in some situations.

Definition at line 146 of file qgsserverexception.h.

Constructor & Destructor Documentation

QgsServerApiException::QgsServerApiException	(	const QString &	code,
		const QString &	message,
		const QString &	mimeType = QStringLiteral( "application/json" ),
		int	responseCode = 200 )

inline

Construction.

Definition at line 150 of file qgsserverexception.h.

QByteArray QgsServerApiException::formatResponse ( QString & responseFormat ) const

inlineoverridevirtual

Formats the exception for sending to client.

Parameters

responseFormat will be set to the content type of the response format.

The default implementation returns text/xml format.

Reimplemented from QgsServerException.

Definition at line 157 of file qgsserverexception.h.

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

/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/server/qgsserverexception.h