Getting Started

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie folgenden Befehl verwenden:

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

Verwenden Sie dann folgende Anweisung:

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 darunterstehenden plattform-spezifischen Anweisungen 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. Das Plugin stellt keine Anfrage an READ_SMS oder RECEIVE_SMS Berechtigungen.

Ihre SMS-Bestätigung muss den von getHashString(). Generieren Sie den Hash für das Signierungskey, das zum Verteilen der App verwendet wird. Debug-, Release- und Play App Signing Builds können unterschiedliche Hashes haben.

Zur Warteschleife für eine Bestätigung SMS

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

Stop Watching

await AndroidSmsRetriever.stopWatch();

Erhalten Sie den App-Hash

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

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

Angeforderte Telefonnummer-Hinweise anfordern

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

Bei Android wird die native Telefonnummer-Hinweis-UI angezeigt und die vom Benutzer ausgewählte Telefonnummer wird zurückgegeben.

Beispiel-SMS

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

Ersetzen Sie die letzte Zeile mit dem Hash für Ihre App-Signierungs-Schlüssel.

Weitermachen von Getting Started

Wenn Sie native Plugin-Arbeit planen, verbinden Sie es mit Einstieg um native Plugin-Arbeit zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-android-sms-retriever für die native Fähigkeit in Verwenden Sie @capgo/capacitor-android-sms-retriever Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins, und Ionic Enterprise Plugin Alternativen für das Produktworkflow in Ionic Enterprise Plugin Alternativen.