@capgo/capacitor-native-biometric

概要

このプラグインは、AndroidおよびiOSのネイティブバイオメトリックAPIにアクセスできます。

基本機能

• isAvailable - バイオメトリック認証ハードウェアが利用可能かどうかを確認します。
• verifyIdentity - ユーザーにバイオメトリック認証を求めます。
• getCredentials - 指定されたサーバーに対して保存されたクレデンシャルを取得します。
• setCredentials - 指定されたサーバーに対して保存されたクレデンシャルを保存します。

パブリック API

メソッド	説明
isAvailable	生体認証ハードウェアが利用可能かどうかを確認します。
addListener	アプリがバックグラウンドから復帰したときに呼び出されるリスナーを追加します。このリスナーは、バックグラウンドにアプリが存在した間、生体認証の利用可能性が変化したかどうかを検出するのに役立ちます。
verifyIdentity	ユーザーに生体認証で認証を求めます。
getCredentials	指定されたサーバーに保存されているクレデンシャルを取得します。
setCredentials	指定されたサーバーにクレデンシャルを保存します。
deleteCredentials	指定されたサーバーに保存されているクレデンシャルを削除します。
getSecureCredentials	BIOMETRY_CURRENT_SET または BIOMETRY_ANY でアクセス制御を設定したクレデンシャルが保存されているサーバーに保存されているクレデンシャルを取得します。生体認証で認証する必要があります。
isCredentialsSaved	指定されたサーバーに保存されているクレデンシャルがすでに保存されているかどうかを確認します。
getPluginVersion	ネイティブ Capacitor プラグインのバージョンを取得します。

ソース オブ トゥルース

このリファレンスはSynced from src/definitions.ts in capacitor-native-biometric.