QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Class defining request with data. More...
#include <qgsbufferserverrequest.h>
Public Member Functions | |
QgsBufferServerRequest (const QString &url, QgsServerRequest::Method method=QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers=QgsServerRequest::Headers(), QByteArray *data=nullptr) | |
Constructor. | |
QgsBufferServerRequest (const QUrl &url, QgsServerRequest::Method method=QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers=QgsServerRequest::Headers(), QByteArray *data=nullptr) | |
Constructor. | |
QByteArray | data () const override |
Returns post/put data Check for QByteArray::isNull() to check if data is available. | |
Public Member Functions inherited from QgsServerRequest | |
QgsServerRequest ()=default | |
QgsServerRequest (const QgsServerRequest &other) | |
QgsServerRequest (const QString &url, QgsServerRequest::Method method=QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers=QgsServerRequest::Headers()) | |
Constructor. | |
QgsServerRequest (const QUrl &url, QgsServerRequest::Method method=QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers=QgsServerRequest::Headers()) | |
Constructor. | |
virtual | ~QgsServerRequest ()=default |
QUrl | baseUrl () const |
Returns the base URL of QGIS server. | |
virtual QString | header (const QString &name) const |
Returns the header value. | |
virtual QString | header (const RequestHeader &headerEnum) const |
Returns the header value. | |
QMap< QString, QString > | headers () const |
Returns the header map. | |
QgsServerRequest::Method | method () const |
QgsServerRequest & | operator= (const QgsServerRequest &)=default |
QUrl | originalUrl () const |
Returns the request url as seen by the web server, by default this is equal to the url seen by QGIS server. | |
QString | parameter (const QString &key, const QString &defaultValue=QString()) const |
Gets a parameter value. | |
QgsServerRequest::Parameters | parameters () const |
Returns a map of query parameters with keys converted to uppercase. | |
const QString | queryParameter (const QString &name, const QString &defaultValue=QString()) const |
Returns the query string parameter with the given name from the request URL, a defaultValue can be specified. | |
void | removeHeader (const QString &name) |
Remove an header. | |
virtual void | removeParameter (const QString &key) |
Remove a parameter. | |
QgsServerParameters | serverParameters () const |
Returns parameters. | |
void | setHeader (const QString &name, const QString &value) |
Set an header. | |
void | setMethod (QgsServerRequest::Method method) |
Set the request method. | |
virtual void | setParameter (const QString &key, const QString &value) |
Set a parameter. | |
virtual void | setUrl (const QUrl &url) |
Set the request url. | |
QUrl | url () const |
Additional Inherited Members | |
Public Types inherited from QgsServerRequest | |
typedef QMap< QString, QString > | Headers |
enum | Method { HeadMethod , PutMethod , GetMethod , PostMethod , DeleteMethod , PatchMethod } |
HTTP Method (or equivalent) used for the request. More... | |
typedef QMap< QString, QString > | Parameters |
enum | RequestHeader { HOST , FORWARDED , X_FORWARDED_FOR , X_FORWARDED_HOST , X_FORWARDED_PROTO , X_QGIS_SERVICE_URL , X_QGIS_WMS_SERVICE_URL , X_QGIS_WFS_SERVICE_URL , X_QGIS_WCS_SERVICE_URL , X_QGIS_WMTS_SERVICE_URL , ACCEPT , USER_AGENT , AUTHORIZATION } |
The internal HTTP Header used for the request as enum. More... | |
Static Public Member Functions inherited from QgsServerRequest | |
static QString | methodToString (const Method &method) |
Returns a string representation of an HTTP request method. | |
Protected Member Functions inherited from QgsServerRequest | |
void | setBaseUrl (const QUrl &url) |
Set the base URL of QGIS server. | |
void | setOriginalUrl (const QUrl &url) |
Set the request original url (the request url as seen by the web server) | |
Class defining request with data.
Definition at line 30 of file qgsbufferserverrequest.h.
QgsBufferServerRequest::QgsBufferServerRequest | ( | const QString & | url, |
QgsServerRequest::Method | method = QgsServerRequest::GetMethod , |
||
const QgsServerRequest::Headers & | headers = QgsServerRequest::Headers() , |
||
QByteArray * | data = nullptr |
||
) |
Constructor.
url | the url string |
method | the request method, default to GET |
headers | optional dictionary of header name-values |
data | optional POST data |
Definition at line 22 of file qgsbufferserverrequest.cpp.
QgsBufferServerRequest::QgsBufferServerRequest | ( | const QUrl & | url, |
QgsServerRequest::Method | method = QgsServerRequest::GetMethod , |
||
const QgsServerRequest::Headers & | headers = QgsServerRequest::Headers() , |
||
QByteArray * | data = nullptr |
||
) |
Constructor.
url | QUrl |
method | the request method, default to GET |
headers | optional dictionary of header name-values |
data | optional POST data |
Definition at line 31 of file qgsbufferserverrequest.cpp.
|
inlineoverridevirtual |
Returns post/put data Check for QByteArray::isNull() to check if data is available.
Reimplemented from QgsServerRequest.
Definition at line 54 of file qgsbufferserverrequest.h.