Getting Started

Installer

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

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

Ensuite, utilisez 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 dispositif Android. Le plugin n'obtient pas READ_SMS ou RECEIVE_SMS vos permissions.

Votre SMS de vérification doit inclure l'empreinte de l'application retournée par getHashString()Générez l'empreinte pour la clé de signature utilisée pour distribuer l'application. Les builds Debug, release et Play App Signing peuvent avoir des empreintes différentes.

Écouter 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 cet hash à la fin du SMS de vérification envoyé par votre backend.

Demander Un Aide-Mémoire Du Numéro De Téléphone

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

Android shows the native Phone Number Hint UI and returns the phone number selected by the user.

Exemple de SMS

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

Remplacez la dernière ligne par le hash de votre clé de signature d'application.

Continuez de l'étape de démarrage

Si vous utilisez Pour planifier le travail de plugin natif, connectez-l’à Pour planifier le travail du plugin natif, connectez-l’à Utilisation de @capgo/capacitor-android-sms-retriever Pour l'implémentation native de la fonctionnalité dans @capgo/capacitor-android-sms-retriever. Capgo Plugin Directory pour le flux de travail du produit dans le répertoire du plugin Capgo Capacitor Plugins by Capgo pour les détails d'implémentation dans Capacitor Plugins par Capgo Ajouter ou Mettre à Jour les Plugins pour le détail d'implémentation dans Ajouter ou Mettre à Jour les Plugins, et Alternatives de Plugins d'Entreprise Ionic Pour le flux de travail du produit dans les plugins Ionic Enterprise.