Class: QgsServerParameter

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

Added in version 3.4.

List of all members, including inherited members

Class Hierarchy

Inheritance diagram of qgis.server.QgsServerParameter

Base classes

QgsServerParameterDefinition

Definition of a parameter with basic conversion methods.

Classes

Name

Methods

raiseError

Raises an error in case of an invalid conversion.

Static Methods

name

Converts a parameter's name into its string representation.

Attributes

FILE_NAME

MAP

REQUEST

SERVICE

UNKNOWN

VERSION_SERVICE

mName

class qgis.server.QgsServerParameter[source]

Bases: QgsServerParameterDefinition

__init__(name: QgsServerParameter.Name = QgsServerParameter.UNKNOWN, type: QMetaType.Type = QMetaType.Type.QString, defaultValue: Any = None)

Constructor for QgsServerParameter.

Parameters:
  • name (QgsServerParameter.Name = QgsServerParameter.UNKNOWN) – The name of the parameter

  • type (QMetaType.Type = QMetaType.Type.QString) – The type of the parameter

  • defaultValue (Any = None) – The default value to use if not defined

__init__(name: QgsServerParameter.Name, type: QVariant.Type, defaultValue: Any = None)

Constructor for QgsServerParameter.

Parameters:
  • name (QgsServerParameter.Name) – The name of the parameter

  • type (QVariant.Type) – The type of the parameter

  • defaultValue (Any = None) – The default value to use if not defined

Deprecated since version 3.38: Use the method with a QMetaType.Type argument instead.

__init__(a0: QgsServerParameter)
Parameters:

a0 (QgsServerParameter)

FILE_NAME = 5
MAP = 4
class Name

Bases: int

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

Converts a parameter’s name into its string representation.

name(name: Optional[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)[source]

Raises an error in case of an invalid conversion.

Raises:

QgsBadRequestException – Invalid parameter exception