QGIS API Documentation 3.41.0-Master (3440c17df1d)
|
Registry for authentication configuration storages. More...
#include <qgsauthconfigurationstorageregistry.h>
Signals | |
void | storageAdded (const QString &id) |
Emitted after a storage was added. | |
void | storageChanged (const QString &id) |
Emitted after a storage was changed. | |
void | storageRemoved (const QString &id) |
Emitted after a storage was removed. | |
Public Member Functions | |
QgsAuthConfigurationStorageRegistry () | |
Creates a new QgsAuthConfigurationStorageRegistry instance. | |
virtual | ~QgsAuthConfigurationStorageRegistry () |
bool | addStorage (QgsAuthConfigurationStorage *storage) |
Add an authentication configuration storage to the registry. | |
QgsAuthConfigurationStorage * | firstReadyStorageWithCapability (Qgis::AuthConfigurationStorageCapability capability) const |
Returns the first ready (and enabled) authentication configuration storage which has the required capability. | |
QList< QgsAuthConfigurationStorage * > | readyStorages () const |
Returns the list of all ready (and enabled) authentication configuration storage. | |
QList< QgsAuthConfigurationStorage * > | readyStoragesWithCapability (Qgis::AuthConfigurationStorageCapability capability) const |
Returns the list of all ready (and enabled) authentication configuration storage with the required capability. | |
bool | removeStorage (const QString &id) |
Remove the authentication configuration storage identified by id from the registry. | |
void | setStorageOrder (const QStringList &orderIds) |
Order the storages by the specified orderIds. | |
QgsAuthConfigurationStorage * | storage (const QString &id) const |
Returns the storage with the specified id or nullptr if not found in the registry. | |
QList< QgsAuthConfigurationStorage * > | storages () const |
Returns the list of all registered authentication configuration storages. | |
Registry for authentication configuration storages.
This singleton class manages a list of authentication configuration storages.
QgsAuthConfigurationStorageRegistry is not usually directly created, but rather accessed through QgsApplication::authConfigurationStorageRegistry().
Definition at line 41 of file qgsauthconfigurationstorageregistry.h.
QgsAuthConfigurationStorageRegistry::QgsAuthConfigurationStorageRegistry | ( | ) |
Creates a new QgsAuthConfigurationStorageRegistry instance.
Definition at line 26 of file qgsauthconfigurationstorageregistry.cpp.
|
virtual |
Definition at line 30 of file qgsauthconfigurationstorageregistry.cpp.
bool QgsAuthConfigurationStorageRegistry::addStorage | ( | QgsAuthConfigurationStorage * | storage | ) |
Add an authentication configuration storage to the registry.
The registry takes ownership of the storage object.
storage | The storage to add |
true
if the storage was added, false
if it was already present in the registry. Definition at line 34 of file qgsauthconfigurationstorageregistry.cpp.
QgsAuthConfigurationStorage * QgsAuthConfigurationStorageRegistry::firstReadyStorageWithCapability | ( | Qgis::AuthConfigurationStorageCapability | capability | ) | const |
Returns the first ready (and enabled) authentication configuration storage which has the required capability.
capability | The capability to look for |
Definition at line 138 of file qgsauthconfigurationstorageregistry.cpp.
QList< QgsAuthConfigurationStorage * > QgsAuthConfigurationStorageRegistry::readyStorages | ( | ) | const |
Returns the list of all ready (and enabled) authentication configuration storage.
Definition at line 104 of file qgsauthconfigurationstorageregistry.cpp.
QList< QgsAuthConfigurationStorage * > QgsAuthConfigurationStorageRegistry::readyStoragesWithCapability | ( | Qgis::AuthConfigurationStorageCapability | capability | ) | const |
Returns the list of all ready (and enabled) authentication configuration storage with the required capability.
capability | The capability to look for |
Definition at line 121 of file qgsauthconfigurationstorageregistry.cpp.
bool QgsAuthConfigurationStorageRegistry::removeStorage | ( | const QString & | id | ) |
Remove the authentication configuration storage identified by id from the registry.
true
if the storage was removed, false
if it was not present in the registry. Definition at line 70 of file qgsauthconfigurationstorageregistry.cpp.
void QgsAuthConfigurationStorageRegistry::setStorageOrder | ( | const QStringList & | orderIds | ) |
Order the storages by the specified orderIds.
orderIds | The ordered list of storage Ids to apply, storages not in the list will be appended at the end. |
Definition at line 169 of file qgsauthconfigurationstorageregistry.cpp.
QgsAuthConfigurationStorage * QgsAuthConfigurationStorageRegistry::storage | ( | const QString & | id | ) | const |
Returns the storage with the specified id or nullptr
if not found in the registry.
id | The id of the storage to retrieve |
Definition at line 154 of file qgsauthconfigurationstorageregistry.cpp.
|
signal |
Emitted after a storage was added.
id | The id of the added storage |
|
signal |
Emitted after a storage was changed.
id | The id of the changed storage |
|
signal |
Emitted after a storage was removed.
id | The id of the removed storage |
QList< QgsAuthConfigurationStorage * > QgsAuthConfigurationStorageRegistry::storages | ( | ) | const |
Returns the list of all registered authentication configuration storages.
Definition at line 90 of file qgsauthconfigurationstorageregistry.cpp.