PhoneAuthProvider class

Proveedor para generar una PhoneAuthCredential .

PhoneAuthProvider no funciona en un entorno Node.js.

Firma:

export declare class PhoneAuthProvider 

Constructores

Propiedades

Métodos

PhoneAuthProvider.(constructor)

Construye una nueva instancia de la clase PhoneAuthProvider

Firma:

constructor(auth: Auth);

Parámetros

PhoneAuthProvider.PHONE_SIGN_IN_METHOD

Siempre configurado en SignInMethod .TELÉFONO.

Firma:

static readonly PHONE_SIGN_IN_METHOD: 'phone';

PhoneAuthProvider.PROVIDER_ID

Siempre configurado en ProviderId .TELÉFONO.

Firma:

static readonly PROVIDER_ID: 'phone';

PhoneAuthProvider.providerId

Siempre configurado en ProviderId .TELÉFONO.

Firma:

readonly providerId: "phone";

PhoneAuthProvider.credencial()

Crea una credencial de autenticación de teléfono, dada la identificación de verificación de PhoneAuthProvider.verifyPhoneNumber() y el código que se envió al dispositivo móvil del usuario.

Firma:

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

Parámetros

Devoluciones:

Credencial de autenticación de teléfono

La credencial del proveedor de autenticación.

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

Ejemplo 2

Se proporciona un flujo alternativo mediante el método signInWithPhoneNumber .

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

PhoneAuthProvider.credentialFromError()

Devuelve una AuthCredential cuando se pasa un error.

Este método funciona para errores como auth/account-exists-with-different-credentials . Esto es útil para recuperar cuando se intenta configurar el número de teléfono de un usuario pero el número en cuestión ya está vinculado a otra cuenta. Por ejemplo, el siguiente código intenta actualizar el número de teléfono del usuario actual y, si eso falla, vincula al usuario con la cuenta asociada a ese número:

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.

Firma:

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

Parámetros

Devoluciones:

Credencial de autenticación | nulo

PhoneAuthProvider.credentialFromResult()

Genera una AuthCredential a partir de una UserCredential .

Firma:

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

Parámetros

Devoluciones:

Credencial de autenticación | nulo

PhoneAuthProvider.verifyPhoneNumber()

Inicia un flujo de autenticación de número de teléfono enviando un código de verificación al número de teléfono proporcionado.

Firma:

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

Parámetros

Devoluciones:

Promesa<cadena>

Una promesa para una ID de verificación que se puede pasar a PhoneAuthProvider.credential() para identificar este flujo.

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

Ejemplo 2

Se proporciona un flujo alternativo mediante el método signInWithPhoneNumber .

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

Ejemplo

// '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);