Sailfish Secrets

API Documentation

InteractionParameters QML Type

Encapsulates parameters related to requesting input from the user More...

Import Statement: import Sailfish.Secrets 1.0

applicationId : string

The identifier of the client application making the request

authenticationPluginName : string

The name of the authentication plugin which will provide the user input flow

collectionName : string

The name of the collection in which the secret is stored, which is associated with the user input request

echoMode : enumeration

The echo mode which should apply as the user provides the input

inputType : enumeration

The type of input required from the user

Constant	Description
`UnknownInput`
`AuthenticationInput`	returns non-empty data if the user authenticates via system dialog
`ConfirmationInput`	returns non-empty data if the user allows the operation
`NumericInput`	returns the numeric (e.g. PIN) data from the user
`AlphaNumericInput`	returns the alphanumeric (e.g. passphrase) data from the user
`FingerprintInput`	returns the fingerprint data from the user
`IrisInput`	returns the iris data from the user
`RetinaInput`	returns the retina data from the user

operation : enumeration

The type of operation which will be performed with the user input once received

Constant	Description
`UnknownOperation`
`RequestUserData`	usually used in conjunction with StoreSecret, i.e. store data requested from user.
`UnlockDatabase`
`LockDatabase`
`ModifyLockDatabase`
`UnlockPlugin`
`LockPlugin`
`ModifyLockPlugin`
`CreateCollection`
`UnlockCollection`
`LockCollection`
`ModifyLockCollection`
`DeleteCollection`
`ReadSecret`
`StoreSecret`
`UnlockSecret`
`LockSecret`
`ModifyLockSecret`
`DeleteSecret`
`Encrypt`
`Decrypt`
`Sign`
`Verify`
`DeriveDigest`
`DeriveMac`
`DeriveKey`
`StoreKey`
`ImportKey`
`CreatePassword`

pluginName : string

The name of the extension plugin which is associated with the user input request

promptText : Sailfish.Secrets.PromptText

The application-specified prompt text to be displayed as part of the user input flow

secretName : string

The name of the secret associated with the user input request