@capgo/capacitor-native-biometric
AndroidおよびiOSのネイティブバイオメトリックAPIにアクセスするプラグインです。
このプラグインは、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. |
エラーの値を使用します。 biometricError 結果から authenticate.
Biometric Auth Errors
Biometric Auth Errors| セクションのタイトル “Biometric Auth Errors” | Code | __CAPGO_KEEP_0__ | プラットフォーム |
|---|---|---|---|
UNKNOWN_ERROR | 0 | 意味 | Android、iOS |
BIOMETRICS_UNAVAILABLE | 1 | 不明なエラーが発生しました。 | __CAPGO_KEEP_0__は利用できません。ハードウェアが欠落または利用できません。 |
USER_LOCKOUT | 2 | Android、iOS | __CAPGO_KEEP_0__は多回の失敗した試行の後、ユーザーはロックアウトされます。 |
BIOMETRICS_NOT_ENROLLED | 3 | Android、iOS | __CAPGO_KEEP_0__はデバイスに登録されていません。 |
USER_TEMPORARY_LOCKOUT | 4 | Android | __CAPGO_KEEP_0__は通常30秒間、ユーザーは一時的にロックアウトされます。 |
AUTHENTICATION_FAILED | 10 | Android、iOS | __CAPGO_KEEP_0__は失敗しました。 |
APP_CANCEL | 11 | iOS | __CAPGO_KEEP_0__は認証フローをキャンセルしました。 |
INVALID_CONTEXT | 12 | iOS | __CAPGO_KEEP_0__ |
NOT_INTERACTIVE | 13 | iOS | __CAPGO_KEEP_0__ |
PASSCODE_NOT_SET | 14 | Android, iOS | デバイスのパスコード、PIN、またはフォールバック認証情報が設定されていません。 |
SYSTEM_CANCEL | 15 | Android, iOS | システムが認証をキャンセルしました。画面ロックなどで例えば。 |
USER_CANCEL | 16 | Android, iOS | ユーザーが認証をキャンセルしました。 |
USER_FALLBACK | 17 | Android, iOS | ユーザーがフォールバック認証を選択しました。 |
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 を使用している場合 Using @capgo/capacitor-native-biometric Using @capgo/capacitor-native-biometric のnative capabilityを使用するには、Using @capgo/capacitor-native-biometricを使用します。 実装詳細については @capgo/capacitor-social-login に @capgo/capacitor-passkey 実装詳細については @capgo/capacitor-passkey に 2要素認証 2要素認証の実装詳細については SSO (企業) 実装詳細については SSO (企業) に