Class: QgsServerParameter

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

Added in version 3.4.

List of all members, including inherited members

Class Hierarchy

Base classes

QgsServerParameterDefinition

Definition of a parameter with basic conversion methods.

Enums

Name

Methods

raiseError

Raises an exception in case of an invalid parameters.

Static Methods

name	Converts a parameter's name into its string representation.

Attributes

mName

class qgis.server.QgsServerParameter

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: Any, defaultValue: Any = None)

Constructor for QgsServerParameter.

Parameters:

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

• type (Any) – 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(*values)

Bases: IntEnum

FILE_NAME = 5

MAP = 4

REQUEST = 3

SERVICE = 1

UNKNOWN = 0

VERSION_SERVICE = 2

REQUEST = 3

SERVICE = 1

UNKNOWN = 0

VERSION_SERVICE = 2

mName

static name(name: QgsServerParameter.Name) → str

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(msg: str | None)

Raises an exception in case of an invalid parameters.

Parameters:

msg – The message describing the exception

Raises:

QgsBadRequestException – Invalid parameter exception