Class: QgsProcessingParameterAuthConfig

A string parameter for authentication configuration ID values.

This parameter allows for users to select from available authentication configurations, or create new authentication configurations as required.

QgsProcessingParameterAuthConfig should be evaluated by calling QgsProcessingAlgorithm.parameterAsString().

Added in version 3.6.

Class Hierarchy

Inheritance diagram of qgis.core.QgsProcessingParameterAuthConfig

Base classes

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.
class qgis.core.QgsProcessingParameterAuthConfig[source]

Bases: QgsProcessingParameterDefinition

__init__(name: str | None, description: str | None = '', defaultValue: Any = None, optional: bool = False)

Constructor for QgsProcessingParameterAuthConfig.

Parameters:

  • name (Optional[str])

  • description (Optional[str] = '')

  • defaultValue (Any = None)

  • optional (bool = False)

__init__(a0: QgsProcessingParameterAuthConfig)
Parameters:

a0 (QgsProcessingParameterAuthConfig)

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterAuthConfig | None[source]

Creates a new parameter using the definition from a script code.

Parameters:

  • name (Optional[str])

  • description (Optional[str])

  • isOptional (bool)

  • definition (Optional[str])

Return type:

Optional[QgsProcessingParameterAuthConfig]

static typeName() → str[source]

Returns the type name for the parameter class.

Return type:

str