Class: QgsServerParameters¶
Provides an interface to retrieve and manipulate global parameters received from the client.
Added in version 3.4.
- class qgis.server.QgsServerParameters[source]¶
Bases:
object- __init__()
Constructor.
- __init__(query: QUrlQuery)
Constructor.
- Parameters:
query (QUrlQuery)
- __init__(a0: QgsServerParameters)
- Parameters:
a0 (QgsServerParameters)
- add(self, key: str | None, value: str | None)[source]¶
Adds a parameter.
- Parameters:
key (Optional[str]) – the name of the parameter
value (Optional[str]) – the value of the parameter
- fileName(self) str[source]¶
Returns FILE_NAME parameter as a string or an empty string if not defined.
- Return type:
str
- Returns:
filename
- load(self, query: QUrlQuery)[source]¶
Loads new parameters.
- Parameters:
query (QUrlQuery) – url query
- virtual loadParameter(self, name: str | None, value: str | None) bool[source]¶
Loads a parameter with a specific value. This method should be implemented in subclasses.
- Parameters:
name (Optional[str])
value (Optional[str])
- Return type:
bool
- map(self) str[source]¶
Returns MAP parameter as a string or an empty string if not defined.
- Return type:
str
- Returns:
map
- remove(self, key: str | None)[source]¶
Removes a parameter.
- Parameters:
key (Optional[str]) – the name of the parameter
remove(self, name: QgsServerParameter.Name) Removes a parameter.
- Parameters:
name – The name of the parameter
Added in version 3.4.
- virtual request(self) str[source]¶
Returns REQUEST parameter as a string or an empty string if not defined.
- Return type:
str
- Returns:
request
- service(self) str[source]¶
Returns SERVICE parameter as a string or an empty string if not defined.
- Return type:
str
- Returns:
service
- toMap(self) Dict[str, str]¶
Returns all parameters in a map.
- Return type:
Dict[str, str]
- urlQuery(self) QUrlQuery[source]¶
Returns a url query with underlying parameters.
- Return type:
QUrlQuery