Getting Started

インストール

AI-Assisted セットアップを使用してプラグインをインストールできます。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.

Manual Setup を使用する場合は、以下のコマンドを実行してプラットフォーム固有の指示に従ってください:

bun add @capgo/capacitor-android-sms-retriever
bunx cap sync android

インポート

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

Android の要件

SMS Retriever は Android デバイス上の Google Play サービスが必要です。プラグインは、SMS Retriever を要求しません。 READ_SMS または RECEIVE_SMS 権限。

アプリハッシュが含まれるSMSを確認する必要があります。 getHashString(). アプリを配布するために使用される署名キーを生成してください。

Debug、Release、Play App Signingのビルドは異なるハッシュを持ちます。

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

コピー

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

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

電話番号ヒントを要求

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

Androidはユーザーが選択した電話番号を返すためにネイティブの電話番号ヒントUIを表示します。

例SMS

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

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

Getting Startedから続けてください

Capgoを使用している場合 Getting Started ネイティブ プラグインの作業を計画するには、 ネイティブ機能のために@capgo/capacitor-android-sms-retrieverを使用する ネイティブ機能のために@capgo/capacitor-android-sms-retrieverを使用する Capgo プラグイン ディレクトリ Capgo プラグイン ディレクトリ Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, プラグインの追加または更新 プラグインの追加または更新 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグイン代替品の製品ワークフローについて。