// Require an alpha-numeric lock code to be provided
 Sailfish::Crypto::InteractionParameters uiParams;
 uiParams.setInputType(Sailfish::Crypto::InteractionParameters::AlphaNumericInput);
 uiParams.setEchoMode(Sailfish::Crypto::InteractionParameters::PasswordEcho);

 // Request that the collection be re-keyed.
 Sailfish::Crypto::CryptoManager cm;
 Sailfish::Crypto::LockCodeRequest lcr;
 lcr.setManager(&cm);
 lcr.setLockCodeRequestType(Sailfish::Crypto::LockCodeRequest::ModifyLockCode);
 lcr.setLockCodeTargetType(Sailfish::Crypto::LockCodeRequest::ExtensionPlugin);
 lcr.setLockCodeTarget(QLatin1String("some.crypto.extension.plugin.name"));
 lcr.setInteractionParameters(uiParams);
 lcr.startRequest(); // status() will change to Finished when complete

Member Function Documentation

LockCodeRequest::LockCodeRequest(QObject *parent = Q_NULLPTR)

Constructs a new LockCodeRequest object with the given parent.

LockCodeRequest::~LockCodeRequest()

Destroys the LockCodeRequest

[virtual] QVariantMap LockCodeRequest::customParameters() const

See also setCustomParameters().

InteractionParameters LockCodeRequest::interactionParameters() const

Returns the user input parameters which should be used when requesting the secret data from the user

Note: Getter function for property interactionParameters.

See also setInteractionParameters().

LockCodeRequestType LockCodeRequest::lockCodeRequestType() const

Returns the type of lock code operation being requested

Note: Getter function for property lockCodeRequestType.

See also setLockCodeRequestType().

QString LockCodeRequest::lockCodeTarget() const

Returns the name of the target to which the lock code operation should be applied

Note: Getter function for property lockCodeTarget.

See also setLockCodeTarget().

LockCodeTargetType LockCodeRequest::lockCodeTargetType() const

Returns the type of the target of the lock code operation

Note: Getter function for property lockCodeTargetType.

See also setLockCodeTargetType().

LockStatus LockCodeRequest::lockStatus() const

Returns the current lock status of the target plugin or metadata database

The value will only be valid if the request's operation is QueryLockStatus. Per-plugin lock status information is also reported from PluginInfoRequest.

Note: Getter function for property lockStatus.

[virtual] Sailfish::Crypto::CryptoManager *LockCodeRequest::manager() const

See also setManager().

[virtual] Sailfish::Crypto::Result LockCodeRequest::result() const

[virtual] void LockCodeRequest::setCustomParameters(const QVariantMap &params)

See also customParameters().

void LockCodeRequest::setInteractionParameters(const InteractionParameters &params)

Sets the user input parameters which should be used when requesting the lock code from the user to params

Note: specifying user input parameters implies that system-mediated user interaction flows are allowed by the calling application, and are required by the collection or standalone secret for which the lock code is being requested.

Note: Setter function for property interactionParameters.

See also interactionParameters().

void LockCodeRequest::setLockCodeRequestType(LockCodeRequestType type)

Sets the type of lock code operation being requested to type

Note: Setter function for property lockCodeRequestType.

See also lockCodeRequestType().

void LockCodeRequest::setLockCodeTarget(const QString &targetName)

Sets the name of the target to which the lock code operation should be applied to name

Note: Setter function for property lockCodeTarget.

See also lockCodeTarget().

void LockCodeRequest::setLockCodeTargetType(LockCodeTargetType type)

Sets the type of the target of the lock code operation to type

Some plugins must be unlocked prior to use, and such plugins should document their semantics for their intended clients.

Note: Setter function for property lockCodeTargetType.

See also lockCodeTargetType().

[virtual] void LockCodeRequest::setManager(Sailfish::Crypto::CryptoManager *manager)

See also manager().

[virtual] void LockCodeRequest::startRequest()

[virtual] Sailfish::Crypto::Request::Status LockCodeRequest::status() const

[virtual] void LockCodeRequest::waitForFinished()