Sailfish::Secrets::SecretManager sm;
 Sailfish::Secrets::CreateCollectionRequest ccr;
 ccr.setManager(&sm);
 ccr.setCollectionName(QLatin1String("ExampleCollection"));
 ccr.setAccessControlMode(Sailfish::Secrets::SecretManager::OwnerOnlyMode);
 ccr.setCollectionLockType(Sailfish::Secrets::CreateCollectionRequest::DeviceLock);
 ccr.setDeviceLockUnlockSemantic(Sailfish::Secrets::SecretManager::DeviceLockKeepUnlocked);
 ccr.setStoragePluginName(Sailfish::Secrets::SecretManager::DefaultEncryptedStoragePluginName);
 ccr.setEncryptionPluginName(Sailfish::Secrets::SecretManager::DefaultEncryptedStoragePluginName);
 ccr.startRequest(); // status() will change to Finished when complete

Member Function Documentation

CreateCollectionRequest::CreateCollectionRequest(QObject *parent = Q_NULLPTR)

Constructs a new CreateCollectionRequest object with the given parent.

CreateCollectionRequest::~CreateCollectionRequest()

Destroys the CreateCollectionRequest

Sailfish::Secrets::SecretManager::AccessControlMode CreateCollectionRequest::accessControlMode() const

Returns the access control mode which will be enforced for the collection

Note: Getter function for property accessControlMode.

See also setAccessControlMode().

QString CreateCollectionRequest::authenticationPluginName() const

Returns the name of the authentication plugin which the client wishes to use to authenticate the user (in order to unlock the collection)

Note: Getter function for property authenticationPluginName.

See also setAuthenticationPluginName().

CollectionLockType CreateCollectionRequest::collectionLockType() const

Returns the type of lock which will be applied to the created collection.

A collection whose lock type is CreateCollectionRequest::DeviceLock will use the device-lock code for its security, whereas a collection whose lock type is CreateCollectionRequest::CustomLock will use a separate pass phrase, PIN code, or other authentication method.

Note: Getter function for property collectionLockType.

See also setCollectionLockType().

QString CreateCollectionRequest::collectionName() const

Returns the name of the collection which the client wishes create

Note: Getter function for property collectionName.

See also setCollectionName().

Sailfish::Secrets::SecretManager::CustomLockUnlockSemantic CreateCollectionRequest::customLockUnlockSemantic() const

Returns the unlock semantic which will apply to the collection if it is protected by a custom lock.

Note: Getter function for property customLockUnlockSemantic.

See also setCustomLockUnlockSemantic().

Sailfish::Secrets::SecretManager::DeviceLockUnlockSemantic CreateCollectionRequest::deviceLockUnlockSemantic() const

Returns the unlock semantic which will apply to the collection if it is protected by the device lock.

Note: Getter function for property deviceLockUnlockSemantic.

See also setDeviceLockUnlockSemantic().

QString CreateCollectionRequest::encryptionPluginName() const

Returns the name of the encryption plugin which the client wishes to use to encrypt secrets stored in the collection

Note: When storagePluginName is the same as encryptionPluginName, then it is assumed that the user means an EncryptedStoragePlugin.

Note: Getter function for property encryptionPluginName.

See also setEncryptionPluginName().

[virtual] Sailfish::Secrets::SecretManager *CreateCollectionRequest::manager() const

See also setManager().

[virtual] Sailfish::Secrets::Result CreateCollectionRequest::result() const

void CreateCollectionRequest::setAuthenticationPluginName(const QString &pluginName)

Sets the name of the authentication plugin which the client wishes to use to authenticate the user (in order to unlock the collection) to pluginName

Note: this will only apply to collections whose collectionLockType() is CreateCollectionRequest::CustomLock.

Note: Setter function for property authenticationPluginName.

See also authenticationPluginName().

void CreateCollectionRequest::setCollectionLockType(CollectionLockType type)

Sets the type of lock which will be applied to the created collection to type

Note: Setter function for property collectionLockType.

See also collectionLockType().

void CreateCollectionRequest::setCollectionName(const QString &name)

Sets the name of the collection which the client wishes to create to name

Note: Setter function for property collectionName.

See also collectionName().

void CreateCollectionRequest::setEncryptionPluginName(const QString &pluginName)

Sets the name of the encryption plugin which the client wishes to use to encrypt secrets stored in the collection to pluginName

Note: Setter function for property encryptionPluginName.

See also encryptionPluginName().

[virtual] void CreateCollectionRequest::setManager(Sailfish::Secrets::SecretManager *manager)

See also manager().

void CreateCollectionRequest::setStoragePluginName(const QString &pluginName)

Sets the name of the storage plugin which the client wishes to use to create the collection to pluginName

Note: Setter function for property storagePluginName.

See also storagePluginName().

[virtual] void CreateCollectionRequest::startRequest()

[virtual] Sailfish::Secrets::Request::Status CreateCollectionRequest::status() const

QString CreateCollectionRequest::storagePluginName() const

Returns the name of the storage plugin which the client wishes to use to create the collection

Note: When storagePluginName is the same as encryptionPluginName, then it is assumed that the user means an EncryptedStoragePlugin.

Note: Getter function for property storagePluginName.

See also setStoragePluginName().

Sailfish::Secrets::SecretManager::UserInteractionMode CreateCollectionRequest::userInteractionMode() const

Returns the user interaction mode required when creating the collection (e.g. if a custom lock code must be requested from the user)

Note: Getter function for property userInteractionMode.

See also setUserInteractionMode().

[virtual] void CreateCollectionRequest::waitForFinished()