capacitor-biometrics

Capacitor plugin that integrates native biometric authentication for both Android and iOS devices into the web application

Install

``bash
npm install capacitor-biometrics-plugin
npx cap sync
`

API

* checkBiometricsCapabilities()
* tryToAuthenticate()
* saveToken(...)
* getToken(...)
* deleteToken(...)
* Interfaces

$3

`typescript
checkBiometricsCapabilities() => Promise
`

Returns: Promise<BiometricsCheckResult>

--------------------

$3

`typescript
tryToAuthenticate() => Promise
`

Returns: Promise<BiometricsAuthResult>

--------------------

$3

`typescript
saveToken(options: SaveTokenOptions) => Promise
`

| Param | Type |
| ------------- | ------------------------------------------------------------- |
| options | SaveTokenOptions |

--------------------

$3

`typescript
getToken(options: GetTokenOptions) => Promise
`

| Param | Type |
| ------------- | ----------------------------------------------------------- |
| options | GetTokenOptions |

Returns: Promise<GetTokenResult>

--------------------

$3

`typescript
deleteToken(options: GetTokenOptions) => Promise
`

| Param | Type |
| ------------- | ----------------------------------------------------------- |
| options | GetTokenOptions |

--------------------

$3


#### BiometricsCheckResult

| Prop | Type | Description |
| ------------------ | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| status | string | The result of the biometric capabilities of the device. Can be one of the following: 'success': This means the device has biometric capabilities and the user has enrolled their biometric data (face or fingerprint). This means the prompt can be launched. 'failed': This means the device has no biometric capabilities. This is accompanied by an error message. 'errorMessage': The reason why the process didn't work. |
| errorMessage | string | |


#### BiometricsAuthResult

| Prop | Type |
| ------------------ | ------------------- |
| status | string |
| errorMessage | string |


#### SaveTokenOptions

| Prop | Type |
| ------------- | ------------------- |
| token | string |
| account | string |


#### GetTokenResult

| Prop | Type |
| ----------- | ------------------- |
| token | string |


#### GetTokenOptions

| Prop | Type |
| ------------- | ------------------- |
| account` | string |