ネイティブバイオメトリック Capacitor プラグイン

@capgo/capacitor-native-biometricを使用

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

インストール

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

bunx cap sync プラグインのネイティブ code をあなたのネイティブ プロジェクトにコピーします。プラグインのアップグレード後は再度実行してください。

インポート

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

APIの概要

Examples

isAvailable()

指定されたキーに対して値がすでに保存されているかどうかを確認します。

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

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

verifyIdentity()

biometric認証ハードウェアが利用可能かどうかを確認します。

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

await NativeBiometric.verifyIdentity();

getCredentials()

ユーザーにbiometric認証を求めます。

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()

指定されたサーバーに対して保存されたクレデンシャルを取得します。

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

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

deleteCredentials()

指定されたサーバーに対してクレデンシャルを保存します。

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

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

getSecureCredentials()

サーバーに保存された資格情報を取得します。BIOMETRY_CURRENT_SETまたはBIOMETRY_ANYで保存された資格情報が必要です。

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.

上の表に記載されている12の基本メソッドがリストされています。リスナーとバージョンヘルパー、各メソッドの完全な契約書は、 GitHub リポジトリ.

イベントをリスンする

addListener ハンドルを返します。画面がアンマウントされたときに呼び出してください。 handle.remove() フルリファレンス

ドキュメント

• GitHub リポジトリ
• Documentation
• 続けてください。@API/__CAPGO_KEEP_1__-native-biometricを使用しています。

あなたは@capgo/capacitor-native-biometricを使用している場合

__CAPGO_KEEP_0__ @capgo/capacitor-native-biometric 認証とアカウントフローの計画、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-biometricと接続 @capgo/capacitor-native-biometric @capgo/capacitor-native-biometricの実装詳細 はじめに Getting Startedの実装詳細 @capgo/capacitor-ソーシャルログイン @capgo/capacitor-ソーシャルログインの実装詳細について @capgo/capacitor-パスコード @capgo/capacitor-パスキーの実装詳細について 2要素認証 Two-factor authenticationの実装詳細