Native Biometrie Capacitor Plugin

Mit @capgo/capacitor-native-biometric

Dieses Plugin bietet Zugriff auf die nativen Biometrie-APIs für Android und iOS.

Installieren

bun add @capgo/capacitor-native-biometric
bunx cap sync

bunx cap sync kopiert das native code des Plugins in deine nativen Projekte. Führe es nach jedem Plugin-Upgrade erneut aus.

Importieren

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

API im Überblick

Beispiele

isAvailable()

Prüft, ob Biometrie-Hardware verfügbar ist.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

const result = await NativeBiometric.isAvailable();
console.log(result);

verifyIdentity()

Fordert den User auf, sich per Biometrie zu authentifizieren.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.verifyIdentity();

getCredentials()

Ruft die gespeicherten Anmeldedaten für einen bestimmten Server ab.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

const result = await NativeBiometric.getCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.

setCredentials()

Speichert die angegebenen Anmeldedaten für einen bestimmten Server.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.setCredentials({
  username: 'username',
  password: 'password',
  server: 'example.com',
});

deleteCredentials()

Löscht die gespeicherten Anmeldedaten für einen bestimmten Server.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.deleteCredentials({ server: 'example.com' });

getSecureCredentials()

Ruft die gespeicherten Anmeldedaten für einen bestimmten Server mit biometrischer Authentifizierung ab. Die Anmeldedaten müssen mit accessControl auf BIOMETRY_CURRENT_SET oder BIOMETRY_ANY gespeichert worden sein.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

const result = await NativeBiometric.getSecureCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.

Die obige Tabelle listet die 12 Kernmethoden auf. Listener, Version-Helper und der vollständige Contract jeder Methode sind in der GitHub-Repository.

Auf Events hören

addListener gibt ein Handle zurück. Rufe handle.remove() wenn der Screen unmounted wird.

Vollständige Referenz

• GitHub-Repository
• Dokumentation
• API Referenz

Weiterlesen mit der Nutzung von @capgo/capacitor-native-biometric

Wenn Sie ... verwenden Mit @capgo/capacitor-native-biometric um Authentifizierungs- und Account-Flows zu planen, verbinde es mit @capgo/capacitor-native-biometric für die Implementierungsdetails in @capgo/capacitor-native-biometric, Erste Schritte für Details zur Implementierung in „Erste Schritte“, @capgo/capacitor-social-login für das Implementierungsdetail in @capgo/capacitor-social-login, @capgo/capacitor-passkey für die Implementierungsdetails in @capgo/capacitor-passkey, und Zwei-Faktor-Authentifizierung für das Implementierungsdetail in der Zwei-Faktor-Authentifizierung.