Class: QgsProcessingParameterAuthConfig¶
- class qgis.core.QgsProcessingParameterAuthConfig¶
Bases:
QgsProcessingParameterDefinition
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 callingQgsProcessingAlgorithm.parameterAsString()
.New in version 3.6.
QgsProcessingParameterAuthConfig(name: str, description: str = ‘’, defaultValue: Any = None, optional: bool = False) Constructor for QgsProcessingParameterAuthConfig.
QgsProcessingParameterAuthConfig(
QgsProcessingParameterAuthConfig
)Methods
- rtype:
str
- rtype:
QgsProcessingParameterDefinition
Creates a new parameter using the definition from a script code.
- rtype:
str
Returns the type name for the parameter class.
- param value:
- asScriptCode(self) str ¶
- Return type:
str
- clone(self) QgsProcessingParameterDefinition ¶
- Return type:
- fromScriptCode(name: str, description: str, isOptional: bool, definition: str) QgsProcessingParameterAuthConfig ¶
Creates a new parameter using the definition from a script code.
- Parameters:
name (str) –
description (str) –
isOptional (bool) –
definition (str) –
- Return type:
- type(self) str ¶
- Return type:
str
- typeName() str ¶
Returns the type name for the parameter class.
- Return type:
str
- valueAsPythonString(self, value: Any, context: QgsProcessingContext) str ¶
- Parameters:
value (Any) –
context (QgsProcessingContext) –
- Return type:
str