Class: QgsServerParameters

class qgis.server.QgsServerParameters

Bases: sip.wrapper

QgsServerParameters provides an interface to retrieve and manipulate global parameters received from the client.

New in version 3.4.

QgsServerParameters() Constructor.

QgsServerParameters(query: QUrlQuery) Constructor.

QgsServerParameters(QgsServerParameters)

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.

Attributes

staticMetaObject

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