encryptSettingsWithBiometry

Encrypts a value 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 encrypting.	null
"onErrorType"	OnErrorType	Type of event that will be fired on error.	null
"onSuccess" (required)	String	Event that is fired if the settings were encrypted.	null
"onSuccessType"	OnSuccessType	Type of event that will be fired on success.	null
"settings" (required)	Object	Mappings of settings to encrypt.	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: Encrypt settings using biometric authentification

Goal: Create a encryptSettingsWithBiometry action using the user's biometric authentification to encrypt settings.

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

{
  "type": "encryptSettingsWithBiometry",
  "params": {
    "leadingDelimiter": "{$",
    "trailingDelimiter": "$}",
    "dynamicParams": {
      "userName": {
        "context": "namedForm",
        "field": "login:userName"
      }
    },
    "settings": {
      "user": "{$userName$}"
    },
    "onSuccess": "encryptSuccess",
    "onError": "encryptError",
    "title": "Check the biometry",
    "subTitle": "For security reasons",
    "description": "To encrypt settings",
    "negativeButton": "No."
  }
}

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

Result:

A encryptSettingsWithBiometry action has been created.