Getting Started

Salin prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-android-sms-retriever`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/android-sms-retriever/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Instalasi

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

Impor

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

Persyaratan Android

Pengguna SMS Retriever memerlukan layanan Google Play di perangkat Android. Plugin ini tidak meminta izin. READ_SMS atau RECEIVE_SMS izin.

Pesan verifikasi SMS Anda harus mencakup hash aplikasi yang dikembalikan oleh getHashString(). Buatlah hash untuk kunci tanda tangan yang digunakan untuk mendistribusikan aplikasi. Pembangunan debug, rilis, dan Play App Signing dapat memiliki hash yang berbeda.

Dengarkan Untuk SMS Verifikasi

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

Hentikan Mengamati

await AndroidSmsRetriever.stopWatch();

Ambil Hash Aplikasi

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

Gunakan hash ini di akhir SMS verifikasi yang dikirim oleh backend Anda.

Minta Petunjuk Nomor Telepon

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

Android menampilkan UI Petunjuk Nomor Telepon native dan mengembalikan nomor telepon yang dipilih oleh pengguna.

Contoh SMS

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

Ganti baris terakhir dengan hash untuk kunci tanda tangan aplikasi Anda.

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan pekerjaan plugin native, hubungkannya dengan Menggunakan @capgo/capacitor-android-sms-retriever untuk kemampuan native di Menggunakan @capgo/capacitor-android-sms-retriever, Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin-Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin-Plugin Capacitor oleh Capgo, Menambahkan atau Mengupdate Plugin untuk detail implementasi dalam Menambahkan atau Mengupdate Plugin, dan Alternatif Plugin Enterprise Ionic untuk alur produk dalam Alternatif Plugin Enterprise Ionic.