QgsProcessingParameterAuthConfig class

A string parameter for authentication configuration configuration ID values.

Reference

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().

Base classes

class QgsProcessingParameterDefinition: Base class for the definition of processing parameters.

Public static functions

static auto fromScriptCode(const QString& name, const QString& description, bool isOptional, const QString& definition) -> QgsProcessingParameterAuthConfig*: Creates a new parameter using the definition from a script code.
static auto typeName() -> QString: Returns the type name for the parameter class.

Constructors, destructors, conversion operators

QgsProcessingParameterAuthConfig(const QString& name, const QString& description = QString(), const QVariant& defaultValue = QVariant(), bool optional = false): Constructor for QgsProcessingParameterAuthConfig.

Public functions

auto asScriptCode() const -> QString override: Returns the parameter definition encoded in a string which can be used within a Python processing script.
auto clone() const -> QgsProcessingParameterDefinition* override: Creates a clone of the parameter definition.
auto type() const -> QString override: Unique parameter type name.
auto valueAsPythonString(const QVariant& value, QgsProcessingContext& context) const -> QString override: Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command.

Function documentation

QString QgsProcessingParameterAuthConfig::valueAsPythonString(const QVariant& value, QgsProcessingContext& context) const override

Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command.

The returned value must be correctly escaped - e.g. string values must be wrapped in ' 's.