Getting Started

GitHub

Kopieren Sie einen Einrichtungshinweis mit den Installationsanweisungen und der vollständigen Markdown-Guide für diesen Plugin.

        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.

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo Fähigkeiten Ihrem AI-Tool mit folgender 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 den 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 permissions.

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

Warten Auf Eine Bestätigungs-Nachricht

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 Verifizierungs-SMS.

Anfordern Sie einen Hinweis auf die Telefonnummer

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 Capgo verwenden Getting Started um native Plugin-Arbeit zu planen, verbinden Sie es mit Mit @capgo/capacitor-android-sms-retriever für die native Fähigkeit in Using @capgo/capacitor-android-sms-retriever Capgo Plugin-Verzeichnis zur Produktionsablauf in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo zur Implementierungsdetails in Capacitor Plugins von Capgo Plugins hinzufügen oder aktualisieren zur Implementierungsdetails in Plugins hinzufügen oder aktualisieren, und Ionische Unternehmens-Plugin-Alternativen für das Produktworkflow in Ionic Enterprise Plugin Alternativen.