1.0.4 • Published 1 month ago

@techdacxi/capacitor-biometrics-plugin v1.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
1 month ago

capacitor-biometrics

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

Install

npm install capacitor-biometrics-plugin
npx cap sync

API

checkBiometricsCapabilities()

checkBiometricsCapabilities() => Promise<BiometricsCheckResult>

Returns: Promise<BiometricsCheckResult>


tryToAuthenticate()

tryToAuthenticate() => Promise<BiometricsAuthResult>

Returns: Promise<BiometricsAuthResult>


saveToken(...)

saveToken(options: SaveTokenOptions) => Promise<void>
ParamType
optionsSaveTokenOptions

getToken(...)

getToken(options: GetTokenOptions) => Promise<GetTokenResult>
ParamType
optionsGetTokenOptions

Returns: Promise<GetTokenResult>


deleteToken(...)

deleteToken(options: GetTokenOptions) => Promise<void>
ParamType
optionsGetTokenOptions

Interfaces

BiometricsCheckResult

PropTypeDescription
statusstringThe 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.
errorMessagestring

BiometricsAuthResult

PropType
statusstring
errorMessagestring

SaveTokenOptions

PropType
tokenstring
accountstring

GetTokenResult

PropType
tokenstring

GetTokenOptions

PropType
accountstring
1.0.4

1 month ago

1.0.2

11 months ago

1.0.1

11 months ago

1.0.3

11 months ago

1.0.0

11 months ago