Sailfish Crypto
API DocumentationStoredKeyIdentifiersRequest Class
(Sailfish::Crypto::StoredKeyIdentifiersRequest)Allows a client request the identifiers of securely-stored keys from the system crypto service More...
Header: | #include <Crypto/storedkeyidentifiersrequest.h> |
Instantiated By: | StoredKeyIdentifiersRequest |
Inherits: | Sailfish::Crypto::Request |
Properties
- collectionName : QString
- identifiers : const QVector<Sailfish::Crypto::Key::Identifier>
- storagePluginName : QString
- 4 properties inherited from Sailfish::Crypto::Request
Public Functions
StoredKeyIdentifiersRequest(QObject *parent = Q_NULLPTR) | |
~StoredKeyIdentifiersRequest() | |
QString | collectionName() const |
QVector<Sailfish::Crypto::Key::Identifier> | identifiers() const |
void | setCollectionName(const QString &name) |
void | setStoragePluginName(const QString &pluginName) |
QString | storagePluginName() const |
Reimplemented Public Functions
virtual QVariantMap | customParameters() const |
virtual Sailfish::Crypto::CryptoManager * | manager() const |
virtual Sailfish::Crypto::Result | result() const |
virtual void | setCustomParameters(const QVariantMap ¶ms) |
virtual void | setManager(Sailfish::Crypto::CryptoManager *manager) |
virtual void | startRequest() |
virtual Sailfish::Crypto::Request::Status | status() const |
virtual void | waitForFinished() |
- 8 public functions inherited from Sailfish::Crypto::Request
Signals
void | collectionNameChanged() |
void | identifiersChanged() |
void | storagePluginNameChanged() |
- 4 signals inherited from Sailfish::Crypto::Request
Detailed Description
Allows a client request the identifiers of securely-stored keys from the system crypto service
Property Documentation
collectionName : QString
Access functions:
QString | collectionName() const |
void | setCollectionName(const QString &name) |
Notifier signal:
void | collectionNameChanged() |
identifiers : const QVector<Sailfish::Crypto::Key::Identifier>
Access functions:
QVector<Sailfish::Crypto::Key::Identifier> | identifiers() const |
Notifier signal:
void | identifiersChanged() |
storagePluginName : QString
Access functions:
QString | storagePluginName() const |
void | setStoragePluginName(const QString &pluginName) |
Notifier signal:
void | storagePluginNameChanged() |
Member Function Documentation
StoredKeyIdentifiersRequest::StoredKeyIdentifiersRequest(QObject *parent = Q_NULLPTR)
Constructs a new StoredKeyIdentifiersRequest object with the given parent.
StoredKeyIdentifiersRequest::~StoredKeyIdentifiersRequest()
Destroys the StoredKeyIdentifiersRequest
QString StoredKeyIdentifiersRequest::collectionName() const
Returns the name of the collection from which the client wishes to retrieve key identifiers
Note: Getter function for property collectionName.
See also setCollectionName().
[virtual]
QVariantMap StoredKeyIdentifiersRequest::customParameters() const
See also setCustomParameters().
QVector<Sailfish::Crypto::Key::Identifier> StoredKeyIdentifiersRequest::identifiers() const
Returns the identifiers of securely-stored keys
Note: this value is only valid if the status of the request is Request::Finished.
Note: Getter function for property identifiers.
[virtual]
Sailfish::Crypto::CryptoManager *StoredKeyIdentifiersRequest::manager() const
See also setManager().
[virtual]
Sailfish::Crypto::Result StoredKeyIdentifiersRequest::result() const
void StoredKeyIdentifiersRequest::setCollectionName(const QString &name)
Sets the name of the collection from which the client wishes to retrieve key identifiers to name
If the collection name is empty, this signifies that the client wishes to retrieve the identifiers of keys stored in any collection. Note that in this case, if some collection stored by the plugin is locked, the client may not be returned any identifiers of keys stored within that collection, and no unlocking flow will be started for such locked collections.
If the collection \name
is non-empty, this signifies that the client wishes to retrieve the identifiers of keys stored only in that collection. If the collection is locked, an unlock flow will be started (prompting the user for the passphrase to unlock that collection).
Note: Setter function for property collectionName.
See also collectionName().
[virtual]
void StoredKeyIdentifiersRequest::setCustomParameters(const QVariantMap ¶ms)
See also customParameters().
[virtual]
void StoredKeyIdentifiersRequest::setManager(Sailfish::Crypto::CryptoManager *manager)
See also manager().
void StoredKeyIdentifiersRequest::setStoragePluginName(const QString &pluginName)
Sets the name of the storage plugin from which the client wishes to retrieve key identifiers to pluginName
Note: Setter function for property storagePluginName.
See also storagePluginName().
[virtual]
void StoredKeyIdentifiersRequest::startRequest()
[virtual]
Sailfish::Crypto::Request::Status StoredKeyIdentifiersRequest::status() const
QString StoredKeyIdentifiersRequest::storagePluginName() const
Returns the name of the storage plugin from which the client wishes to retrieve key identifiers
Note: Getter function for property storagePluginName.
See also setStoragePluginName().