スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用します：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-android-sms-retriever` plugin in my project.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

npm install @capgo/capacitor-android-sms-retriever
npx cap sync android

クイックスタート

ワンタイムSMSを待ち受け、OTPを抽出してから、ユーザーが code をリクエストする前にリトリーバーを開始します。

import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';

const smsListener = await AndroidSmsRetriever.addListener('smsReceived', ({ message }) => {
  const code = message.match(/\b\d{4,8}\b/)?.[0];
  if (code) submitCode(code);
  // The SMS also ends with your 11-character app hash; validate it separately from the OTP.
});

await AndroidSmsRetriever.startWatch();

// When the flow completes:
await smsListener.remove();
await AndroidSmsRetriever.stopWatch();

よくある落とし穴

• ハッシュ: SMSテンプレートには、アプリのリトリーバーハッシュを含める必要があります。
• タイムアウト: ユーザーが新しい code をリクエストしたら、ウォッチを再起動します。
• Google Play 開発者サービス: デバイスへのインストールが必要です。

インポート

import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';

Androidの要件

SMS Retrieverを使用するには、AndroidデバイスにGoogle Play servicesが必要です。このプラグインは READ_SMS または RECEIVE_SMS 権限を要求しません。

認証用SMSには、以下から返されるアプリハッシュを含める必要があります： getHashString()アプリの配布に使用する署名キーのハッシュを生成してください。Debug、release、およびPlay App Signingの各ビルドでは、ハッシュが異なる場合があります。

認証SMSの受信待機

import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';

const received = await AndroidSmsRetriever.addListener('smsReceived', ({ message }) => {
  const code = message.match(/\b\d{6}\b/)?.[0];
  console.log('Verification code:', code);
});

const timeout = await AndroidSmsRetriever.addListener('smsRetrieverTimeout', () => {
  console.log('SMS Retriever timed out');
});

const errors = await AndroidSmsRetriever.addListener('smsRetrieverError', ({ message }) => {
  console.error('SMS Retriever error:', message);
});

await AndroidSmsRetriever.startWatch();

// Remove listeners when the verification flow is done.
await received.remove();
await timeout.remove();
await errors.remove();

監視を停止

await AndroidSmsRetriever.stopWatch();

App Hashの取得

const { hash } = await AndroidSmsRetriever.getHashString();
console.log(hash);

バックエンドから送信される認証SMSの末尾に、このハッシュを使用してください。

電話番号ヒントのリクエスト

const { phoneNumber } = await AndroidSmsRetriever.getPhoneNumber();
console.log(phoneNumber);

AndroidのネイティブなPhone Number Hint UIが表示され、ユーザーが選択した電話番号が返されます。

SMSの例

<#> 123456 is your verification code.
FA+9qCX9VSu

最終行をアプリ署名キーのハッシュに置き換えてください。

Getting Startedの続きを進める

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