QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | List of all members
QgsAuthMethodMetadata Class Reference

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

#include <qgsauthmethodmetadata.h>

Public Member Functions

 QgsAuthMethodMetadata (const QString &key, const QString &description, const QString &library=QString())
 Construct an authentication method metadata container. More...
 
virtual ~QgsAuthMethodMetadata ()=default
 
virtual QgsAuthMethodcreateAuthMethod () const
 Class factory to return a pointer to a newly created QgsDataProvider object. More...
 
QString description () const
 Returns descriptive text for the method. More...
 
QString key () const
 Returns the unique key associated with the method. More...
 
QString library () const
 Returns the library file name. More...
 

Detailed Description

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

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.

Note
not available in Python bindings

Definition at line 43 of file qgsauthmethodmetadata.h.

Constructor & Destructor Documentation

◆ QgsAuthMethodMetadata()

QgsAuthMethodMetadata::QgsAuthMethodMetadata ( const QString &  key,
const QString &  description,
const QString &  library = QString() 
)
inline

Construct an authentication method metadata container.

Parameters
keyTextual key of the library plugin
descriptionDescription of the library plugin
libraryFile name of library plugin (empty if the provider is not loaded from a library)

Definition at line 54 of file qgsauthmethodmetadata.h.

◆ ~QgsAuthMethodMetadata()

virtual QgsAuthMethodMetadata::~QgsAuthMethodMetadata ( )
virtualdefault

Member Function Documentation

◆ createAuthMethod()

QgsAuthMethod * QgsAuthMethodMetadata::createAuthMethod ( ) const
virtual

Class factory to return a pointer to a newly created QgsDataProvider object.

Since
QGIS 3.22

Definition at line 39 of file qgsauthmethodmetadata.cpp.

◆ description()

QString QgsAuthMethodMetadata::description ( ) const

Returns descriptive text for the method.

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

Definition at line 29 of file qgsauthmethodmetadata.cpp.

◆ key()

QString QgsAuthMethodMetadata::key ( ) const

Returns the unique key associated with the method.

This key string is used for the associative container in QgsAtuhMethodRegistry

Definition at line 24 of file qgsauthmethodmetadata.cpp.

◆ library()

QString QgsAuthMethodMetadata::library ( ) const

Returns the library file name.

This is used to QLibrary calls to load the method.

Definition at line 34 of file qgsauthmethodmetadata.cpp.


The documentation for this class was generated from the following files: