Getting Started

インストール

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

インポート

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

Androidの要件

Android デバイス上の Google Play サービスが必要です。プラグインは READ_SMS または RECEIVE_SMS 許可を求めません。

アプリのハッシュが含まれるSMSが必要です。ハッシュは getHashString()で生成する必要があります。

Listen For A Verification 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();

Stop Watching

await AndroidSmsRetriever.stopWatch();

__CAPGO_KEEP_0__を取得する

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

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

電話番号のヒントを要求する

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

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

例SMS

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

アプリ署名キーで署名されたハッシュを置き換えてください。

Getting Startedから続けて

Capacitorを使用している場合 Getting Started native pluginの作業を計画する場合、Capacitorを Capacitorのnative機能と連携するために@capgo/capacitor-android-sms-retrieverを使用する Capacitorのnative機能と連携するために@capgo/capacitor-android-sms-retrieverを使用する Capgo Plugin Directory Capgo Plugin Directory Capacitor Plugins by Capgo Capacitor Plugins by Capgo プラグインの追加または更新 __CAPGO_KEEP_0__の実装詳細については、プラグインの追加または更新の際の Capacitorエンタープライズプラグインの代替 __CAPGO_KEEP_0__の製品ワークフローについては、Capacitorエンタープライズプラグインの代替を参照してください。