decryptSettingsWithBiometry

Decrypts a value that was previously encrypted with personal biometric information. Uses the options available on the users device and operating system.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"description"	String	Description of the biometry pop-up.	null
"negativeButton"	String	Text of the cancel button in the biometry pop-up.	null
"onError"	String	Event that is fired if there was an error decrypting.	null
"onErrorType"	OnErrorType	Type of event that will be fired on error.	null
"onSuccess" (required)	String	Event that is fired if the settings were decrypted.	null
"onSuccessType"	OnSuccessType	Type of event that will be fired on success.	null
"settings" (required)	Array	List of settings to decrypt.	null
"subTitle"	String	Subtitle of the biometry pop-up.	null
"title"	String	Title of biometry pop-up.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Decrypt settings using biometric authentification

Goal: Create a decryptSettingsWithBiometry action checking the user's biometric authentification to decrypt settings.

The settings to be decrypted are specified in the settings parameter.

{
  "type": "decryptSettingsWithBiometry",
  "params": {
    "settings": [
      "user"
    ],
    "onSuccess": "decryptSuccess",
    "onError": "decryptError",
    "title": "Check the biometry",
    "subTitle": "For security reasons",
    "description": "To decrypt settings",
    "negativeButton": "No."
  }
}

The title, subTitle, description and negaticeButton parameters specifiy the text that is displayed in the biometry pop-up.

Result:

A decryptSettingsWithBiometry action has been created.