Sailfish Secrets
API DocumentationCollectionNamesRequest Class
(Sailfish::Secrets::CollectionNamesRequest)Allows a client request the names of collections of secrets from the system secrets service More...
| Header: | #include <Secrets/collectionnamesrequest.h> |
| Inherits: | Sailfish::Secrets::Request |
Properties
- collectionNames : const QStringList
- storagePluginName : QString
- 3 properties inherited from Sailfish::Secrets::Request
Public Functions
| CollectionNamesRequest(QObject *parent = Q_NULLPTR) | |
| ~CollectionNamesRequest() | |
| QStringList | collectionNames() const |
| bool | isCollectionLocked(const QString &collectionName) const |
| void | setStoragePluginName(const QString &pluginName) |
| QString | storagePluginName() const |
Reimplemented Public Functions
| virtual Sailfish::Secrets::SecretManager * | manager() const |
| virtual Sailfish::Secrets::Result | result() const |
| virtual void | setManager(Sailfish::Secrets::SecretManager *manager) |
| virtual void | startRequest() |
| virtual Sailfish::Secrets::Request::Status | status() const |
| virtual void | waitForFinished() |
- 6 public functions inherited from Sailfish::Secrets::Request
Signals
| void | collectionNamesChanged() |
| void | storagePluginNameChanged() |
- 3 signals inherited from Sailfish::Secrets::Request
Detailed Description
Allows a client request the names of collections of secrets from the system secrets service
This class allows clients to request the Secrets service return the names of collections of secrets which are stored in a particular storage plugin. Note that the client may not have the ability to read from or write to any collection returned from this method, depending on the access controls which apply to the collections.
An example of requesting collection names follows:
Sailfish::Secrets::SecretManager sm; Sailfish::Secrets::CollectionNamesRequest cnr; cnr.setManager(&sm); cnr.setStoragePluginName(Sailfish::Secrets::SecretManager::DefaultEncryptedStoragePluginName); cnr.startRequest(); // status() will change to Finished when complete // collectionNames() will contain the names of the collections
Property Documentation
collectionNames : const QStringList
Access functions:
| QStringList | collectionNames() const |
Notifier signal:
| void | collectionNamesChanged() |
storagePluginName : QString
Access functions:
| QString | storagePluginName() const |
| void | setStoragePluginName(const QString &pluginName) |
Notifier signal:
| void | storagePluginNameChanged() |
Member Function Documentation
CollectionNamesRequest::CollectionNamesRequest(QObject *parent = Q_NULLPTR)
Constructs a new CollectionNamesRequest object with the given parent.
CollectionNamesRequest::~CollectionNamesRequest()
Destroys the CollectionNamesRequest
QStringList CollectionNamesRequest::collectionNames() const
Returns the names of the collections stored by the specified storage plugin
Note: Getter function for property collectionNames.
bool CollectionNamesRequest::isCollectionLocked(const QString &collectionName) const
Returns true if the collection with the specified collectionName was locked when this request was performed.
Note that the value reported by this method will not automatically update if a collection is subsequently unlocked (e.g. by performing a StoredKeyIdentifiersRequest with the collection name set to the given collection); instead, the user must start this request again, and then the updated value will be reported appropriately.
[virtual] Sailfish::Secrets::SecretManager *CollectionNamesRequest::manager() const
See also setManager().
[virtual] Sailfish::Secrets::Result CollectionNamesRequest::result() const
[virtual] void CollectionNamesRequest::setManager(Sailfish::Secrets::SecretManager *manager)
See also manager().
void CollectionNamesRequest::setStoragePluginName(const QString &pluginName)
Sets the name of the storage plugin from which the client wishes to retrieve collection names to pluginName
Note: Setter function for property storagePluginName.
See also storagePluginName().
[virtual] void CollectionNamesRequest::startRequest()
[virtual] Sailfish::Secrets::Request::Status CollectionNamesRequest::status() const
QString CollectionNamesRequest::storagePluginName() const
Returns the name of the storage plugin from which the client wishes to retrieve collection names
Note: Getter function for property storagePluginName.
See also setStoragePluginName().