Class: QgsServerParameters¶
-
class
qgis.server.
QgsServerParameters
¶ Bases:
sip.wrapper
Constructor.
QgsServerParameters(query: QUrlQuery) Constructor.
QgsServerParameters(
QgsServerParameters
)QgsServerParameters
provides an interface to retrieve and manipulate global parameters received from the client.Methods
Adds a parameter.
Removes all parameters.
Returns FILE_NAME parameter as a string or an empty string if not defined.
Loads new parameters.
Loads a parameter with a specific value.
Returns MAP parameter as a string or an empty string if not defined.
Removes a parameter.
Returns REQUEST parameter as a string or an empty string if not defined.
Returns SERVICE parameter as a string or an empty string if not defined.
Returns all parameters in a map.
Returns a url query with underlying parameters.
Returns the value of a parameter.
Returns VERSION parameter as a string or an empty string if not defined.
Attributes
-
add
(self, key: str, value: str)¶ Adds a parameter.
- Parameters
key (str) – the name of the parameter
value (str) – the value of the parameter
-
clear
(self)¶ Removes all parameters.
-
fileName
(self) → str¶ Returns FILE_NAME parameter as a string or an empty string if not defined.
- Return type
str
- Returns
filename
-
load
(self, query: QUrlQuery)¶ Loads new parameters.
- Parameters
query (QUrlQuery) – url query
-
loadParameter
(self, name: str, value: str) → bool¶ Loads a parameter with a specific value. This method should be implemented in subclasses.
- Parameters
name (str) –
value (str) –
- Return type
bool
-
map
(self) → str¶ Returns MAP parameter as a string or an empty string if not defined.
- Return type
str
- Returns
map
-
remove
(self, key: str)¶ Removes a parameter.
- Parameters
key (str) – the name of the parameter
remove(self, name: QgsServerParameter.Name) Removes a parameter.
- Parameters
name – The name of the parameter
New in version 3.4.
-
request
(self) → str¶ Returns REQUEST parameter as a string or an empty string if not defined.
- Return type
str
- Returns
request
-
service
(self) → str¶ Returns SERVICE parameter as a string or an empty string if not defined.
- Return type
str
- Returns
service
-
staticMetaObject
= <PyQt5.QtCore.QMetaObject object>¶
-
toMap
(self) → Dict[str, str]¶ Returns all parameters in a map.
- Return type
Dict[str, str]
-
urlQuery
(self) → QUrlQuery¶ Returns a url query with underlying parameters.
- Return type
QUrlQuery
-
value
(self, key: str) → str¶ Returns the value of a parameter.
- Parameters
key (str) – the name of the parameter
- Return type
str
-
version
(self) → str¶ Returns VERSION parameter as a string or an empty string if not defined.
- Return type
str
- Returns
version
-