Exception base class for API exceptions. More...
#include <qgsserverexception.h>
Inheritance diagram for QgsServerApiException:
Public Member Functions | |
| QgsServerApiException (const QString &code, const QString &message, const QString &mimeType=QStringLiteral("application/json"), int responseCode=200) | |
| Construction. More... | |
| QByteArray | formatResponse (QString &responseFormat) const override |
| Formats the exception for sending to client. More... | |
 Public Member Functions inherited from QgsServerException | |
| QgsServerException (const QString &message, int responseCode=500) | |
| Constructor. More... | |
| virtual QByteArray | formatResponse (QString &responseFormat) const |
| Formats the exception for sending to client. More... | |
| int | responseCode () const |
| Public Member Functions inherited from QgsException | |
| QgsException (const QString &message) | |
| Constructor for QgsException, with the specified error message. More... | |
| virtual | ~QgsException ()=default throw () |
| 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.
- Since
- QGIS 3.10
Definition at line 147 of file qgsserverexception.h.
Constructor & Destructor Documentation
◆ QgsServerApiException()
|
inline |
Construction.
Definition at line 151 of file qgsserverexception.h.
Member Function Documentation
◆ formatResponse()
|
inlineoverridevirtual |
Formats the exception for sending to client.
- Parameters
-
responseFormat QString to store the content type of the response format.
- Returns
- QByteArray The formatted response.
The default implementation returns text/xml format.
Reimplemented from QgsServerException.
Definition at line 158 of file qgsserverexception.h.
The documentation for this class was generated from the following file:
- /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/server/qgsserverexception.h
