Vue d'ensemble
Section intitulée « Vue d'ensemble »Ce plugin donne accès aux API biométriques natives pour Android et iOS.
Capacités de base
Section intitulée « Capacités de base »isAvailable- Vérifie si le matériel d'authentification biométrique est disponible.verifyIdentity- Demande à l'utilisateur de s'authentifier avec des biométriques.getCredentials- Récupère les informations de connexion stockées pour un serveur donné.setCredentials- Stocke les informations de connexion données pour un serveur donné.
Public API
Section intitulée « Public API »| Méthode | Description |
|---|---|
isAvailable | Vérifie si le matériel d'authentification biométrique est disponible. |
addListener | Ajoute un écouteur qui est appelé lorsque l'application reprend en arrière-plan. Cela est utile pour détecter si la disponibilité de la biométrie a changé pendant que l'application était en arrière-plan (par exemple, utilisateur inscrit/désinscrit des biométries). |
verifyIdentity | Invite l'utilisateur à s'authentifier avec des biométries. |
getCredentials | Récupère les informations d'identification stockées pour un serveur donné. |
setCredentials | Stocke les informations d'identification données pour un serveur donné. |
deleteCredentials | Supprime les informations d'identification stockées pour un serveur donné. |
getSecureCredentials | Récupère les informations d'identification stockées pour un serveur donné, en exigeant une authentification biométrique. Les informations d'identification doivent avoir été stockées avec accessControl défini sur BIOMETRY_CURRENT_SET ou BIOMETRY_ANY. |
isCredentialsSaved | Vérifie si des informations d'identification sont déjà enregistrées pour un serveur donné. |
getPluginVersion | Obtient la version native du plugin Capacitor. |
Valeurs de référence
Section intitulée « Valeurs de référence »Utilisez ces valeurs lors du traitement des biometricError résultats provenant de authenticate.
Erreurs d'authentification biométrique
Section intitulée « Erreurs d'authentification biométrique »| Valeur | Code | Plateforme | Signification |
|---|---|---|---|
UNKNOWN_ERROR | 0 | Android, iOS | Une erreur inconnue s'est produite. |
BIOMETRICS_UNAVAILABLE | 1 | Android, iOS | Les biométriques sont indisponibles en raison d'un matériel manquant ou indisponible. |
USER_LOCKOUT | 2 | Android, iOS | L'utilisateur est bloqué après trop d'essais ratés. |
BIOMETRICS_NOT_ENROLLED | 3 | Android, iOS | Aucune biométrique n'est enregistrée sur le dispositif. |
USER_TEMPORARY_LOCKOUT | 4 | Android | L'utilisateur est temporairement bloqué, généralement pendant 30 secondes. |
AUTHENTICATION_FAILED | 10 | Android, iOS | L'authentification a échoué. |
APP_CANCEL | 11 | iOS | L'application a annulé la progression d'authentification. |
INVALID_CONTEXT | 12 | iOS | Le contexte d'authentification est invalide. |
NOT_INTERACTIVE | 13 | iOS | L'authentification n'a pas été interactive. |
PASSCODE_NOT_SET | 14 | Android, iOS | Le code d'accès du dispositif, le PIN ou le mot de passe de secours n'est pas configuré. |
SYSTEM_CANCEL | 15 | Android, iOS | Le système a annulé l'authentification, par exemple après verrouillage de l'écran. |
USER_CANCEL | 16 | Android, iOS | L'utilisateur a annulé l'authentification. |
USER_FALLBACK | 17 | Android, iOS | L'utilisateur a choisi l'authentification de secours. |
Source Of Truth
Section intitulée « Source De Vérité »Cette référence est synchronisée à partir de src/definitions.ts en capacitor-biométrique-native.
Continuez à partir de @capgo/capacitor-biométrique-native
Section intitulée « Continuez à partir de @capgo/capacitor-biométrique-native »Si vous utilisez @capgo/capacitor-biométrique-native pour planifier l'authentification et les flux de compte, connectez-le avec En utilisant @capgo/capacitor-biométrique-native pour la capacité native dans En utilisant @capgo/capacitor-biométrique-native, @capgo/capacitor-connexion-social pour les détails d'implémentation dans @capgo/capacitor-connexion sociale @capgo/capacitor-passkey pour les détails d'implémentation dans @capgo/capacitor-passkey Authentification à deux facteurs pour les détails d'implémentation dans l'authentification à deux facteurs, et SSO (Entreprise) pour les détails d'implémentation dans SSO (Entreprise).