Getting Started

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Utilisez ensuite la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

Exigences Android

Le récupérateur de SMS nécessite les services Google Play sur le appareil Android. Le plugin ne demande pas READ_SMS ou RECEIVE_SMS permissions.

Votre SMS de vérification doit inclure l'hash de l'application retourné par getHashString(). Générez l'hash pour la clé de signature utilisée pour distribuer l'application. Les builds de débogage, de production et de Play App Signing peuvent avoir différents hashes.

Écoutez Un SMS De Vérification

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

Arrêter de regarder

await AndroidSmsRetriever.stopWatch();

Obtenir L'Hash De L'Application

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

Utilisez cette chaîne à la fin du SMS de vérification envoyé par votre backend.

Demander un indice de numéro de téléphone

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

Sur Android, le UI de l'indice de numéro de téléphone est affiché nativement et le numéro de téléphone sélectionné par l'utilisateur est retourné.

Exemple de SMS

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

Remplacez la dernière ligne par la chaîne de clé de signature de votre application.

Continuez de Getting Started

If vous utilisez Prise en main pour planifier le travail de plugin natif, connectez-le à Utilisation de @capgo/capacitor-android-sms-retriever pour la capacité native dans l'utilisation de @capgo/capacitor-android-sms-retriever, Répertoire de plugin Capgo pour le flux de travail du produit dans le Répertoire de plugin Capgo, Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo, Ajout ou mise à jour de plugins pour le détail d'implémentation dans Ajout ou mise à jour de plugins, et Alternatives de plugins d'entreprise Ionic pour le flux de travail du produit dans les alternatives du plugin Enterprise Ionic.