このプラグインは、Android と iOS のネイティブバイオメトリック API にアクセスすることができます。
isAvailable- バイオメトリック認証ハードウェアが利用可能かどうかを確認します。verifyIdentity- ユーザーにバイオメトリック認証を求めます。getCredentials- 指定されたサーバーに保存されているクレデンシャルを取得します。setCredentials- 指定されたサーバーにクレデンシャルを保存します。
パブリック API
「API」の公開セクション| メソッド | 説明 |
|---|---|
isAvailable | バイオメトリック認証ハードウェアが利用可能かどうかを確認します。 |
addListener | アプリがバックグラウンドから復帰したときに呼び出されるリスナーを追加します。このリスナーは、バックグラウンドにアプリが存在した間、ユーザーがバイオメトリックを登録/解除した場合に有用です。 |
verifyIdentity | ユーザーにバイオメトリック認証を求めます。 |
getCredentials | 指定されたサーバーに保存されているクレデンシャルを取得します。 |
setCredentials | 指定されたサーバーにクレデンシャルを保存します。 |
deleteCredentials | 指定されたサーバーに保存されているクレデンシャルを削除します。 |
getSecureCredentials | 指定されたサーバーに保存されているクレデンシャルを取得し、バイオメトリック認証が必要です。クレデンシャルは、BIOMETRY_CURRENT_SETまたはBIOMETRY_ANYでアクセス制御を設定した場合にのみ取得できます。 |
isCredentialsSaved | 指定されたサーバーに保存されているクレデンシャルがすでに存在するかどうかを確認します。 |
getPluginVersion | Get the native Capacitor plugin version. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-native-biometric.
Keep going from @capgo/capacitor-native-biometric
Section titled “Keep going from @capgo/capacitor-native-biometric”If you are using @capgo/capacitor-native-biometric to plan authentication and account flows, connect it with Using @capgo/capacitor-native-biometric for the native capability in Using @capgo/capacitor-native-biometric, @capgo/capacitor-social-login 実装詳細については @capgo/capacitor-social-login を参照してください。 @capgo/capacitor-passkey 実装詳細については @capgo/capacitor-passkey を参照してください。 2要素認証 2要素認証の実装詳細についてはこちらを参照してください。 SSO (Enterprise) SSO (Enterprise) の実装詳細についてはこちらを参照してください。