概要
概要セクション@capgo/capacitor-android-sms-retriever Google Play サービス SMS リトリーバーと Android-only Capacitor 検証フロー用の Phone Number Hint API をラップします。
プラグインは、SMS 権限の要求なしでアプリに送信された単一の検証 SMS をリスンするようにアプリを許可します。また、ユーザーが SIM ベースの電話番号を手動で入力せずに選択できるように、Android のネイティブ Phone Number Hint UI を表示することもできます。
主な機能
主な機能セクションstartWatch- 1 つの検証 SMS に対して 5 分間の SMS リトリーバー ウォッチを開始します。stopWatch- アクティブな SMS リトリーバー ウォッチを停止します。getHashString- 検証 SMS メッセージで使用される 11 文字のアプリ ハッシュを読み取ります。getPhoneNumber- Android の Phone Number Hint を開き、選択された電話番号を返します。smsReceived- 取得された検証 SMS をリスンします。smsRetrieverTimeout- 5 分間のタイムアウトをリスンします。smsRetrieverError- Android または Google Play サービスからランタイム エラーをリスンします。
プラットフォーム サポート
プラットフォーム サポート| プラットフォーム | サポート |
|---|---|
| Android | サポート |
| iOS | 非サポートのスタブ |
| Web | 非サポートのスタブ |
パブリック API
Section titled “パブリック API”| メソッド | 説明 |
|---|---|
startWatch | 1回の検証SMSを1回聴取する。 |
stopWatch | 現在の監視を停止する。 |
getHashString | 11文字のアプリハッシュを返す。 |
getPhoneNumber | 電話番号ヒントを表示し、選択された番号を返す。 |
addListener('smsReceived', ...) | 取得したSMSペイロードを受け取る。 |
addListener('smsRetrieverTimeout', ...) | タイムアウトイベントを処理する。 |
addListener('smsRetrieverError', ...) | リトリーバー エラーを処理する。 |
getPluginVersion | ネイティブ プラグイン バージョンを返す。 |
ソース オブ トゥルース
Section titled “ソース オブ トゥルース”このリファレンスは、 src/definitions.ts にsynced capacitor-android-sms-retriever.