PhoneAuthProvider class

Anbieter zum Generieren eines PhoneAuthCredential .

PhoneAuthProvider funktioniert nicht in einer Node.js-Umgebung.

Unterschrift:

export declare class PhoneAuthProvider 

Konstrukteure

Eigenschaften

Methoden

PhoneAuthProvider.(Konstruktor)

Konstruiert eine neue Instanz der PhoneAuthProvider Klasse

Unterschrift:

constructor(auth: Auth);

Parameter

PhoneAuthProvider.PHONE_SIGN_IN_METHOD

Immer auf SignInMethod setzen .TELEFON.

Unterschrift:

static readonly PHONE_SIGN_IN_METHOD: 'phone';

PhoneAuthProvider.PROVIDER_ID

Immer auf ProviderId setzen .TELEFON.

Unterschrift:

static readonly PROVIDER_ID: 'phone';

PhoneAuthProvider.providerId

Immer auf ProviderId setzen .TELEFON.

Unterschrift:

readonly providerId: "phone";

PhoneAuthProvider.credential()

Erstellt anhand der Verifizierungs-ID von PhoneAuthProvider.verifyPhoneNumber() und des Codes, der an das Mobilgerät des Benutzers gesendet wurde, einen Telefonauthentifizierungsnachweis.

Unterschrift:

static credential(verificationId: string, verificationCode: string): PhoneAuthCredential;

Parameter

Kehrt zurück:

PhoneAuthCredential

Die Anmeldeinformationen des Authentifizierungsanbieters.

Beispiel 1

const provider = new PhoneAuthProvider(auth);
const verificationId = provider.verifyPhoneNumber(phoneNumber, applicationVerifier);
// Obtain verificationCode from the user.
const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
const userCredential = signInWithCredential(auth, authCredential);

Beispiel 2

Ein alternativer Ablauf wird mit der Methode signInWithPhoneNumber bereitgestellt.

const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain verificationCode from the user.
const userCredential = await confirmationResult.confirm(verificationCode);

PhoneAuthProvider.credentialFromError()

Gibt ein AuthCredential zurück, wenn ein Fehler übergeben wird.

Diese Methode funktioniert bei Fehlern wie auth/account-exists-with-different-credentials . Dies ist nützlich für die Wiederherstellung, wenn Sie versuchen, die Telefonnummer eines Benutzers festzulegen, die betreffende Nummer jedoch bereits mit einem anderen Konto verknüpft ist. Der folgende Code versucht beispielsweise, die Telefonnummer des aktuellen Benutzers zu aktualisieren. Wenn dies fehlschlägt, wird der Benutzer mit dem Konto verknüpft, das dieser Nummer zugeordnet ist:

const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber(number, verifier);
try {
  const code = ''; // Prompt the user for the verification code
  await updatePhoneNumber(
      auth.currentUser,
      PhoneAuthProvider.credential(verificationId, code));
} catch (e) {
  if ((e as FirebaseError)?.code === 'auth/account-exists-with-different-credential') {
    const cred = PhoneAuthProvider.credentialFromError(e);
    await linkWithCredential(auth.currentUser, cred);
  }
}

// At this point, auth.currentUser.phoneNumber === number.

Unterschrift:

static credentialFromError(error: FirebaseError): AuthCredential | null;

Parameter

Kehrt zurück:

AuthCredential | Null

PhoneAuthProvider.credentialFromResult()

Erzeugt ein AuthCredential aus einem UserCredential .

Unterschrift:

static credentialFromResult(userCredential: UserCredential): AuthCredential | null;

Parameter

Kehrt zurück:

AuthCredential | Null

PhoneAuthProvider.verifyPhoneNumber()

Startet einen Authentifizierungsprozess für Telefonnummern, indem ein Bestätigungscode an die angegebene Telefonnummer gesendet wird.

Unterschrift:

verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier: ApplicationVerifier): Promise<string>;

Parameter

Kehrt zurück:

Versprechen<string>

Ein Versprechen für eine Verifizierungs-ID, die an PhoneAuthProvider.credential() übergeben werden kann, um diesen Fluss zu identifizieren.

Beispiel 1

const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber(phoneNumber, applicationVerifier);
// Obtain verificationCode from the user.
const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
const userCredential = await signInWithCredential(auth, authCredential);

Beispiel 2

Ein alternativer Ablauf wird mit der Methode signInWithPhoneNumber bereitgestellt.

const confirmationResult = signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain verificationCode from the user.
const userCredential = confirmationResult.confirm(verificationCode);

Beispiel

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
const userCredential = await signInWithCredential(auth, phoneCredential);