Sailfish Secrets
API DocumentationSecretManager Class
(Sailfish::Secrets::SecretManager)Allows clients to make requests of the system secrets service. More...
| Header: | #include <Secrets/secretmanager.h> |
Public Types
| enum | AccessControlMode { OwnerOnlyMode, SystemAccessControlMode, NoAccessControlMode } |
| enum | CustomLockUnlockSemantic { CustomLockKeepUnlocked, CustomLockDeviceLockRelock, CustomLockTimoutRelock, CustomLockAccessRelock } |
| enum | DeviceLockUnlockSemantic { DeviceLockKeepUnlocked, DeviceLockVerifyLock, DeviceLockRelock } |
| enum | FilterOperator { OperatorOr, OperatorAnd } |
| enum | UserInteractionMode { PreventInteraction, SystemInteraction, ApplicationInteraction } |
Public Functions
| SecretManager(QObject *parent = Q_NULLPTR) | |
| virtual | ~SecretManager() |
| bool | isInitialized() const |
| void | registerInteractionView(Sailfish::Secrets::InteractionView *view) |
Signals
| void | isInitializedChanged() |
Detailed Description
Allows clients to make requests of the system secrets service.
The SecretManager class provides an interface to the system secrets service. In order to perform requests, clients should use the Request type specific for their needs:
- Sailfish::Secrets::PluginInfoRequest to request information about available secrets plugins
- Sailfish::Secrets::CollectionNamesRequest to request the names of collections of secrets stored by the secrets service
- Sailfish::Secrets::CreateCollectionRequest to create a collection in which to store secrets
- Sailfish::Secrets::DeleteCollectionRequest to delete a collection of secrets
- Sailfish::Secrets::StoreSecretRequest to store a secret either in a collection or standalone
- Sailfish::Secrets::StoredSecretRequest to retrieve a secret
- Sailfish::Secrets::FindSecretsRequest to search a collection for secrets matching a filter
- Sailfish::Secrets::DeleteSecretRequest to delete a secret
- Sailfish::Secrets::InteractionRequest to request the system mediate a user-interaction flow on behalf of the application
Member Type Documentation
enum SecretManager::AccessControlMode
enum SecretManager::CustomLockUnlockSemantic
enum SecretManager::DeviceLockUnlockSemantic
enum SecretManager::FilterOperator
enum SecretManager::UserInteractionMode
Member Function Documentation
SecretManager::SecretManager(QObject *parent = Q_NULLPTR)
Constructs a new SecretManager instance with the given parent.
[virtual] SecretManager::~SecretManager()
Destroys the SecretManager
bool SecretManager::isInitialized() const
Returns true if the DBus connection has been established