Class: QgsServerRequest¶
-
class
qgis.server.
QgsServerRequest
¶ Bases:
sip.wrapper
Constructor
QgsServerRequest(url: str, method: QgsServerRequest.Method = QgsServerRequest.GetMethod, headers: Dict[str, str] = {}) Constructor
- Parameters
url – the url string
method – the request method
headers –
QgsServerRequest(url: QUrl, method: QgsServerRequest.Method = QgsServerRequest.GetMethod, headers: Dict[str, str] = {}) Constructor
- Parameters
url – QUrl
method – the request method
headers –
QgsServerRequest(
QgsServerRequest
)Methods
Returns post/put data Check for QByteArray.isNull() to check if data is available.
Returns the header value
Returns the header map
- rtype
QgsServerRequest.Method
Returns the request url as seen by the web server, by default this is equal to the url seen by QGIS server
Gets a parameter value
Returns a map of query parameters with keys converted to uppercase
Remove an header
Remove a parameter
Returns parameters
Set an header
Set the request method
Set the request original
url
(the request url as seen by the web server)Set a parameter
Set the request url
- rtype
QUrl
Attributes
-
DeleteMethod
= 4¶
-
GetMethod
= 2¶
-
HeadMethod
= 0¶
-
class
Method
¶ Bases:
int
-
PostMethod
= 3¶
-
PutMethod
= 1¶
-
data
(self) → QByteArray¶ Returns post/put data Check for QByteArray.isNull() to check if data is available.
- Return type
QByteArray
-
header
(self, name: str) → str¶ Returns the header value
- Parameters
name (str) – of the header
- Return type
str
- Returns
the header value or an empty string
-
headers
(self) → Dict[str, str]¶ Returns the header map
- Return type
Dict[str, str]
- Returns
the headers map
-
method
(self) → QgsServerRequest.Method¶ - Return type
- Returns
the request method
-
originalUrl
(self) → QUrl¶ Returns the request url as seen by the web server, by default this is equal to the url seen by QGIS server
See also
New in version 3.6.
- Return type
QUrl
-
parameter
(self, key: str) → str¶ Gets a parameter value
- Parameters
key (str) –
- Return type
str
-
parameters
(self) → Dict[str, str]¶ Returns a map of query parameters with keys converted to uppercase
- Return type
Dict[str, str]
-
removeHeader
(self, name: str)¶ Remove an header
- Parameters
name (str) –
-
removeParameter
(self, key: str)¶ Remove a parameter
- Parameters
key (str) –
-
serverParameters
(self) → QgsServerParameters¶ Returns parameters
- Return type
-
setHeader
(self, name: str, value: str)¶ Set an header
- Parameters
name (str) –
value (str) –
-
setMethod
(self, method: QgsServerRequest.Method)¶ Set the request method
- Parameters
method (QgsServerRequest.Method) –
-
setOriginalUrl
(self, url: QUrl)¶ Set the request original
url
(the request url as seen by the web server)See also
New in version 3.6.
- Parameters
url (QUrl) –
-
setParameter
(self, key: str, value: str)¶ Set a parameter
- Parameters
key (str) –
value (str) –
-
setUrl
(self, url: QUrl)¶ Set the request url
- Parameters
url (QUrl) –
-
url
(self) → QUrl¶ - Return type
QUrl
- Returns
the request url as seen by QGIS server
See also
server, by default the two are equal