Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrer KI-Tool mithilfe der folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die Plattform-spezifischen Anweisungen unten befolgen:

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

Importieren

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

Android-Anforderungen

SMS-Retriever erfordert Google Play-Dienste auf dem Android-Gerät. Der Plugin stellt keine Anfrage READ_SMS oder RECEIVE_SMS Die App muss die erforderlichen Berechtigungen haben.

Ihre Verifizierungs-Nachricht muss den App-Hash enthalten, der von getHashString()erstellt wird. Generieren Sie den Hash für das Signierungs-Zertifikat, das zum Verteilen der App verwendet wird. Debug-, Release- und Play App Signing-Builds können unterschiedliche Hashes haben.

Warten Sie auf eine Bestätigungsnachricht

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

Beobachtung beenden

await AndroidSmsRetriever.stopWatch();

App-Hash erhalten

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

Verwenden Sie diesen Hash am Ende der Bestätigungsnachricht, die Ihr Backend sendet.

Eine Telefonnummer anfordern

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

Android zeigt die native Telefonnummer-Hinweis-Oberfläche an und gibt die vom Benutzer ausgewählte Telefonnummer zurück.

Beispiel-SMS

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

Ersetzen Sie die letzte Zeile durch den Hash für Ihre App-Zertifizierungs-Schlüssel.

Weitermachen von Getting Started

Wenn Sie native Plugin-Arbeit planen, verbinden Sie es mit Getting Started zur Planung von native Plugin-Arbeit, verbinden Sie es mit Using @capgo/capacitor-android-sms-retriever für die native Funktion in Verwendung von @capgo/capacitor-android-sms-retriever, Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo für die Implementierungsdetail in Capacitor Plugins von Capgo, Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetail in Hinzufügen oder Aktualisieren von Plugins, und Ionic-Enterprise-Plugin-Alternativen für den Produktworkflow in Ionic-Enterprise-Plugin-Alternativen.