Getting Started

Installation

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem KI-Tool hinzu, indem Sie die folgende Befehlszeile verwenden:

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 den unten angegebenen Plattform-spezifischen Anweisungen folgen:

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

Importieren

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

Android-Anforderungen

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

Ihre Verifizierungs-Nachricht muss den von der App zurückgegebenen App-Hash enthalten. Generieren Sie den Hash für das Signierungs-Zertifikat, das zum Verteilen der App verwendet wird. Führen Sie Debug-, Release- und Play App Signing-Builds mit unterschiedlichen Hashes aus. getHashString()Die App muss die erforderlichen Berechtigungen haben.

Für eine Bestätigungs-Nachricht abrufen

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 von Ihrem Backend gesendeten Bestätigungs-Nachricht.

Eine Telefonnummer-Vorschlagsanfrage stellen

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-Zertifizierungsstelle.

Weitermachen von Getting Started

Wenn Sie native Plugin-Arbeit planen, verbinden Sie es mit Getting Started um native Plugin-Arbeit zu planen, 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.