checkBiometry

Opens the device's system prompt for biometric authentication. Depending on the hardware capabilities, this can be (not limited to) fingerprint or face recognition, for example.

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 will be fired if biometry was not OK.	null
"onErrorType"	OnErrorType	Type of event that will be fired on error.	null
"onSuccess" (required)	String	Event that will be fired if biometry was OK.	null
"onSuccessType"	OnSuccessType	Type of event that will be fired on success.	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: Check the user's biometry

Goal: Create a checkBiometry action that verifys the user's biometric authentification.

To achieve this the following code can be used:

{
  "type": "checkBiometry",
  "params": {
    "onSuccess": "checkSuccess",
    "onError": "checkError",
    "title": "Check the biometry",
    "subTitle": "For security reasons",
    "description": "To get access",
    "negativeButton": "No."
  }
}

The onSuccess and onError events are fired depending on the result of the user's biometric check.

Result:

A checkBiometry action has been created.