QgsAuthMethodMetadata class

Holds data auth method key, description, and associated shared library file information.

Contents

The metadata class is used in a lazy load implementation in QgsAuthMethodRegistry. To save memory, auth methods are only actually loaded via QLibrary calls if they're to be used. (Though they're all iteratively loaded once to get their metadata information, and then unloaded when the QgsAuthMethodRegistry is created.) QgsProviderMetadata supplies enough information to be able to later load the associated shared library object.

Constructors, destructors, conversion operators

QgsAuthMethodMetadata(const QString& _key, const QString& _description, const QString& _library)
Construct an authentication method metadata container.

Public functions

auto description() const -> QString
This returns descriptive text for the method.
auto key() const -> QString
This returns the unique key associated with the method.
auto library() const -> QString
This returns the library file name.

Function documentation

QgsAuthMethodMetadata::QgsAuthMethodMetadata(const QString& _key, const QString& _description, const QString& _library)

Construct an authentication method metadata container.

Parameters
_key Textual key of the library plugin
_description Description of the library plugin
_library File name of library plugin

QString QgsAuthMethodMetadata::description() const

This returns descriptive text for the method.

This is used to provide a descriptive list of available data methods.

QString QgsAuthMethodMetadata::key() const

This returns the unique key associated with the method.

This key string is used for the associative container in QgsAtuhMethodRegistry

QString QgsAuthMethodMetadata::library() const

This returns the library file name.

This is used to QLibrary calls to load the method.