Class: QgsServerParameter

class qgis.server.QgsServerParameter

Bases: qgis._server.QgsServerParameterDefinition

Parameter common to all services (WMS, WFS, …)

New in version 3.4.

QgsServerParameter(name: QgsServerParameter.Name = QgsServerParameter.UNKNOWN, type: QVariant.Type = QVariant.String, defaultValue: Any = None) Constructor for QgsServerParameter.

Parameters
  • name – The name of the parameter

  • type – The type of the parameter

  • defaultValue – The default value to use if not defined

QgsServerParameter(QgsServerParameter)

Methods

name

Converts a parameter's name into its string representation.

raiseError

Raises an error in case of an invalid conversion.

Attributes

FILE_NAME

MAP

REQUEST

SERVICE

UNKNOWN

VERSION_SERVICE

staticMetaObject

FILE_NAME = 5
MAP = 4
class Name

Bases: int

baseClass

alias of QgsServerParameter

REQUEST = 3
SERVICE = 1
UNKNOWN = 0
VERSION_SERVICE = 2
mName
name(name: QgsServerParameter.Name) str

Converts a parameter’s name into its string representation.

name(name: str) -> QgsServerParameter.Name Converts a string into a parameter’s name (UNKNOWN in case of an invalid string).

Parameters

name (QgsServerParameter.Name) –

Return type

str

raiseError(self)

Raises an error in case of an invalid conversion.

Raises

QgsBadRequestException – Invalid parameter exception

staticMetaObject = <PyQt5.QtCore.QMetaObject object>