メインコンテンツへスキップ

@capgo/capacitor-android-sms-retriever

SMS権限なしで、Androidで特定のアプリ宛てのSMS OTPを1件読み取ります。

Retrieverを開始し、以下を待機します smsReceived, SMS本文から数字のOTPを抽出し、サーバー側でRetriever API のために付与した末尾11文字のアプリハッシュを検証します。

プラットフォームサポート備考
iOSといいえオートフィルまたはパスキーを使用する
AndroidはいSMS Retriever API
Webいいえ対象外
  • startWatch - 検証用SMSを受信するため、5分間のSMS Retriever待機を開始します。
  • stopWatch - 実行中のSMS Retriever待機を停止します。
  • getHashString - 検証用SMSで使用される11文字のアプリハッシュを読み取ります。
  • getPhoneNumber - Android Phone Number Hintを開き、選択された電話番号を返します。
  • smsReceived - 受信した検証用SMSを検知します。
  • smsRetrieverTimeout - 5分間のタイムアウトを検知します。
  • smsRetrieverError - AndroidまたはGoogle Play servicesからのランタイムエラーを検知します。
プラットフォームサポート
Android対応
iOSとサポートされていないスタブ
Webサポートされていないスタブ
メソッド説明
startWatch認証用SMSの受信待機を開始します。
stopWatch受信待機を停止します。
getHashString11文字のアプリハッシュを返します。
getPhoneNumber電話番号ヒントを表示し、選択された番号を返します。
addListener('smsReceived', ...)取得したSMSのペイロードを受信します。
addListener('smsRetrieverTimeout', ...)タイムアウトイベントを処理します。
addListener('smsRetrieverError', ...)リトリーバーのエラーを処理します。
getPluginVersionネイティブプラグインのバージョンを返します。

このリファレンスは以下から同期されています: src/definitions.ts における capacitor-android-sms-retriever.

@capgo/capacitor-android-sms-retrieverの続き

「@capgo/capacitor-android-sms-retrieverの続き」セクション

使用している場合 @capgo/capacitor-android-sms-retriever ネイティブプラグインの作業を計画するには、次と連携してください: @capgo/capacitor-android-sms-retriever の使用方法 @capgo/capacitor-android-sms-retrieverを使用する場合のネイティブ機能について Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。