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.

New in version 3.4: Enums

Methods

add Adds a parameter.
clear Removes all parameters.
fileName Returns FILE_NAME parameter as a string or an empty string if not defined.
load Loads new parameters.
loadParameter Loads a parameter with a specific value.
map Returns MAP parameter as a string or an empty string if not defined.
remove Removes a parameter.
request Returns REQUEST parameter as a string or an empty string if not defined.
service Returns SERVICE parameter as a string or an empty string if not defined.
toMap Returns all parameters in a map.
urlQuery Returns a url query with underlying parameters.
value Returns the value of a parameter.
version Returns VERSION parameter as a string or an empty string if not defined.

Signals

Attributes

staticMetaObject
add(self, key: str, value: str)

Adds a parameter.

Parameters:
  • key – the name of the parameter
  • value – 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.

Returns:filename
load(self, query: QUrlQuery)

Loads new parameters.

Parameters:query – url query
loadParameter(self, name: str, value: str) → bool

Loads a parameter with a specific value. This method should be implemented in subclasses.

map(self) → str

Returns MAP parameter as a string or an empty string if not defined.

Returns:map
remove(self, key: str)

Removes a parameter.

Parameters:key – 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.

Returns:request
service(self) → str

Returns SERVICE parameter as a string or an empty string if not defined.

Returns:service
staticMetaObject = <PyQt5.QtCore.QMetaObject object>
toMap(self) → Dict[str, str]

Returns all parameters in a map.

urlQuery(self) → QUrlQuery

Returns a url query with underlying parameters.

value(self, key: str) → str

Returns the value of a parameter.

Parameters:key – the name of the parameter
version(self) → str

Returns VERSION parameter as a string or an empty string if not defined.

Returns:version