capacitor-biometric-lock
v1.0.0
Published
Lock and unlock an app with biometrics
Downloads
414
Readme
capacitor-biometric-lock
Lock and unlock an app with biometrics
Install
npm install capacitor-biometric-lock
npx cap sync
API
configure(...)
configure(options?: BiometricLockConfiguration | undefined) => Promise<void>
Set plugin configuration
| Param | Type |
| ------------- | --------------------------------------------------------------------------------- |
| options
| BiometricLockConfiguration |
Since: 1.0.0
getConfiguration()
getConfiguration() => Promise<BiometricLockConfiguration>
Get plugin configuration
Returns: Promise<BiometricLockConfiguration>
Since: 1.0.0
getBiometricMethod()
getBiometricMethod() => Promise<BiometricMethodResult>
Get primary biometric method
Returns: Promise<BiometricMethodResult>
Since: 1.0.0
Interfaces
BiometricLockConfiguration
Persisted configuration of the plugin
| Prop | Type | Description |
| ---------------------- | -------------------- | ---------------------------- |
| enabled
| boolean | |
| timeoutInSeconds
| number | |
| appName
| string | |
| retryButtonColor
| string | Hex color code e.g. "00ffee" |
BiometricMethodResult
| Prop | Type |
| --------------------- | ----------------------------------------------------------- |
| biometricMethod
| BiometricMethod |
Enums
BiometricMethod
| Members | Value | Description |
| ------------------------------- | -------------- | ----------------------------------------------- |
| none
| 0 | No biometry is available |
| touchId
| 1 | iOS Touch ID is available |
| faceId
| 2 | iOS Face ID is available |
| fingerprintAuthentication
| 3 | Android fingerprint authentication is available |
| faceAuthentication
| 4 | Android face authentication is available |
| irisAuthentication
| 5 | Android iris authentication is available |