Notice for App Developers

  • iOS

Requires adding permission on the application's Info.plist:

<plist [...]>
<dict>
// User permission for biometic authentication using Face ID or Touch ID
<key>NSFaceIDUsageDescription</key>
<string>YOUR TEXT</string>
[...]
</dict>
</plist>

Hierarchy

  • Biometrics

Methods

  • Checks if biometrics are registered on the device.

    Example:

    let biometricStatus = await Eitri.biometrics.checkStatus()
    console.log(biometricStatus)

    /* Example output from this console.log:
    { status: "AVAILABLE" }
    */

    Compatibility Control

    • API LEVEL 10 - Functionality added

    Returns Promise<BiometricCheckStatusOutput>

  • Authenticate using biometrics.

    Example:

    let result = await Eitri.biometrics.authenticate({
    android: {
    promptInfo: {
    title: "Login",
    subtitle: "Validate your credentials.",
    cancelButton: "Cancel"
    }
    },
    ios: {
    authenticationReason: "Authenticate using your biometrics."
    }
    })
    console.log(result)

    /* Example output from this console.log:
    { type: "FaceID", result: "FAILED", details: "USER_CANCEL"}
    */

    Compatibility Control

    • API LEVEL 10 - Functionality added

    Parameters

    Returns Promise<BiometricAuthenticateOutput>

Generated using TypeDoc