Getting Started

Instalar

bun add @capgo/capacitor-firebase-authentication
bunx cap sync

Importar

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

API Resumen

applyActionCode

Aplica un código de verificación code enviado al usuario por correo electrónico.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.applyActionCode({} as ApplyActionCodeOptions);

confirmPasswordReset

Completa el proceso de restablecimiento de contraseña.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.confirmPasswordReset({} as ConfirmPasswordResetOptions);

confirmVerificationCode

Finaliza el proceso de verificación del número de teléfono.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.confirmVerificationCode({} as ConfirmVerificationCodeOptions);

createUserWithEmailAndPassword

Crear una cuenta de usuario con correo electrónico y contraseña. Si se creó la nueva cuenta, el usuario se autenticó automáticamente.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.createUserWithEmailAndPassword({} as CreateUserWithEmailAndPasswordOptions);

deleteUser

Borrar y desconectar al usuario.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.deleteUser();

fetchSignInMethodsForEmail

Obtiene los métodos de inicio de sesión para una dirección de correo electrónico.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.fetchSignInMethodsForEmail({} as FetchSignInMethodsForEmailOptions);

getCurrentUser

Obtiene al usuario actualmente conectado.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getCurrentUser();

getPendingAuthResult

Devuelve el SignInResult si su aplicación lanzó un flujo de inicio de sesión web y el sistema operativo elimina la aplicación mientras está en segundo plano.

Solo disponible para Android.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getPendingAuthResult();

getIdToken

Obtiene el token de autenticación de Firebase para el usuario actualmente conectado.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getIdToken();

getIdTokenResult

Devuelve un token web JSON (JWT) deserializado utilizado para identificar al usuario a un servicio de Firebase.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getIdTokenResult();

getRedirectResult

Devuelve el SignInResult desde el flujo de inicio de sesión basado en redirección.

Si el inicio de sesión fue infructuoso, falla con un error. Si no se llamó ninguna operación de redirección, devuelve un SignInResult con un usuario nulo.

Solo disponible para Web.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getRedirectResult();

getTenantId

Obtener el id de inquilino.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getTenantId();

isSignInWithEmailLink

Verifica si un enlace de entrada es un enlace de inicio de sesión con correo electrónico adecuado para signInWithEmailLink.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.isSignInWithEmailLink({} as IsSignInWithEmailLinkOptions);

linkWithApple

Asocia la cuenta de usuario con el proveedor de autenticación de Apple.

El usuario debe estar conectado en el nivel nativo. La skipNativeAuth opción de configuración no tiene efecto aquí.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithApple();

linkWithEmailAndPassword

Asocia la cuenta de usuario con el proveedor de autenticación de correo electrónico.

El usuario debe estar conectado en el nivel nativo. La skipNativeAuth opción de configuración no tiene efecto aquí.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithEmailAndPassword({} as LinkWithEmailAndPasswordOptions);

linkWithEmailLink

Asocia la cuenta de usuario con el proveedor de autenticación de correo electrónico.

El usuario debe estar conectado en el nivel nativo. La skipNativeAuth opción de configuración no tiene efecto aquí.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithEmailLink({} as LinkWithEmailLinkOptions);

linkWithFacebook

Asocia la cuenta de usuario con el proveedor de autenticación de Facebook.

El usuario debe estar conectado en el nivel nativo. La skipNativeAuth opción de configuración no tiene efecto aquí.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithFacebook();

linkWithGameCenter

Asocia la cuenta de usuario con el proveedor de autenticación de Game Center.

El usuario debe estar conectado en el nivel nativo. skipNativeAuth La

opción de configuración no tiene efecto aquí.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithGameCenter();

linkWithGithub

Links the user account with GitHub authentication provider.

Conecta la cuenta de usuario con __CAPGO_KEEP_0__ proveedor de autenticación. skipNativeAuth El usuario debe estar conectado en el nivel nativo.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithGithub();

linkWithGoogle

Copiar a portapapeles

Sección titulada “vincularConGoogle”','Conecta la cuenta de usuario con el proveedor de autenticación de Google.','.El usuario debe estar conectado en el nivel nativo. skipNativeAuth La opción de configuración no tiene efecto aquí.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithGoogle();

linkWithMicrosoft

Vincula la cuenta de usuario con el proveedor de autenticación de Microsoft.

El usuario debe estar conectado en la capa nativa. La skipNativeAuth La opción de configuración no tiene efecto aquí.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithMicrosoft();

linkWithOpenIdConnect

Vincula la cuenta de usuario con un proveedor de OpenID Connect.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithOpenIdConnect({} as LinkWithOpenIdConnectOptions);

linkWithPhoneNumber

Vincula la cuenta de usuario con el proveedor de autenticación de número de teléfono.

El usuario debe estar conectado en la capa nativa. skipNativeAuth La opción de configuración no tiene efecto aquí.

Use el phoneVerificationCompleted escuchador para ser notificado cuando se complete la verificación. phoneVerificationFailed Use el phoneCodeSent escuchador para ser notificado cuando se falla la verificación.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithPhoneNumber({} as LinkWithPhoneNumberOptions);

linkWithPlayGames

Copiar a portapapeles

Sección titulada “vincularConPlayGames” skipNativeAuth Vincula la cuenta de usuario con el proveedor de autenticación de Play Games.

El usuario debe estar conectado en la capa nativa. La opción de configuración no tiene efecto aquí. Solo disponible para Android.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithPlayGames();

linkWithTwitter

Conecta la cuenta de usuario con el proveedor de autenticación de Twitter.

El usuario debe estar conectado en la capa nativa. La skipNativeAuth opción de configuración no tiene efecto aquí.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithTwitter();

linkWithYahoo

Conecta la cuenta de usuario con el proveedor de autenticación de Yahoo.

El usuario debe estar conectado en la capa nativa. La skipNativeAuth opción de configuración no tiene efecto aquí.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithYahoo();

reload

Recarga los datos de cuenta del usuario, si está conectado.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.reload();

revokeAccessToken

Revoca el token de acceso proporcionado. Actualmente solo admite tokens de acceso OAuth de Apple.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.revokeAccessToken({} as RevokeAccessTokenOptions);

sendEmailVerification

Envía un correo de verificación al usuario actualmente conectado.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendEmailVerification();

sendPasswordResetEmail

Envía un correo de restablecimiento de contraseña.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendPasswordResetEmail({} as SendPasswordResetEmailOptions);

sendSignInLinkToEmail

Envía un enlace de correo electrónico de inicio de sesión al usuario con la dirección de correo electrónico especificada.

Para completar el inicio de sesión con el enlace de correo electrónico, llame a signInWithEmailLink con la dirección de correo electrónico y el enlace de correo electrónico proporcionado en el correo electrónico enviado al usuario.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendSignInLinkToEmail({} as SendSignInLinkToEmailOptions);

setLanguageCode

Establece el idioma de usuario code para operaciones de autenticación.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setLanguageCode({} as SetLanguageCodeOptions);

setPersistence

Establece el tipo de persistencia para la sesión de autenticación actualmente guardada.

Solo disponible para Web.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setPersistence({} as SetPersistenceOptions);

setTenantId

Establece el identificador de inquilino.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setTenantId({} as SetTenantIdOptions);

signInAnonymously

Inicia sesión como un usuario anónimo.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInAnonymously();

signInWithApple

Inicia el flujo de inicio de sesión con Apple.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithApple();

signInWithCustomToken

Inicia el flujo de inicio de sesión con Token personalizado.

Este método no se puede utilizar en combinación con skipNativeAuth en Android e iOS. En este caso, debes utilizar el signInWithCustomToken interface de la JS de Firebase SDK directamente.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithCustomToken({} as SignInWithCustomTokenOptions);

signInWithEmailAndPassword

Inicia el flujo de inicio de sesión utilizando un correo electrónico y contraseña.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithEmailAndPassword({} as SignInWithEmailAndPasswordOptions);

signInWithEmailLink

Inicia sesión utilizando un correo electrónico y un enlace de inicio de sesión.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithEmailLink({} as SignInWithEmailLinkOptions);

signInWithFacebook

Inicia el flujo de inicio de sesión con Facebook.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithFacebook();

signInWithGameCenter

Inicia el flujo de inicio de sesión de Game Center.

Solo disponible para iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithGameCenter();

signInWithGithub

Inicia el flujo de inicio de sesión de GitHub.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithGithub();

signInWithGoogle

Inicia el flujo de inicio de sesión de Google.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithGoogle();

signInWithMicrosoft

Inicia el flujo de inicio de sesión de Microsoft.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithMicrosoft();

signInWithOpenIdConnect

Inicia el flujo de inicio de sesión con OpenID Connect.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithOpenIdConnect({} as SignInWithOpenIdConnectOptions);

signInWithPhoneNumber

Inicia el flujo de inicio de sesión utilizando un número de teléfono.

Utilice el phoneVerificationCompleted listener para ser notificado cuando la verificación esté completa. phoneVerificationFailed listener para ser notificado cuando la verificación haya fallado. phoneCodeSent listener para obtener el ID de verificación.

Solo disponible para Android e iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithPhoneNumber({} as SignInWithPhoneNumberOptions);

signInWithPlayGames

Inicia el flujo de inicio de sesión de Play Games.

Solo disponible para Android.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithPlayGames();

signInWithTwitter

Inicia el flujo de inicio de sesión de Twitter.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithTwitter();

signInWithYahoo

Inicia el flujo de inicio de sesión de Yahoo.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithYahoo();

signOut

Inicia el flujo de cierre de sesión.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signOut();

unlink

Desvincula un proveedor de una cuenta de usuario.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.unlink({} as UnlinkOptions);

updateEmail

Actualiza la dirección de correo electrónico del usuario actualmente conectado.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updateEmail({} as UpdateEmailOptions);

updatePassword

Actualiza la contraseña del usuario actualmente conectado.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updatePassword({} as UpdatePasswordOptions);

updateProfile

Actualiza los datos de perfil de un usuario.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updateProfile({} as UpdateProfileOptions);

useAppLanguage

Establece el idioma de usuario code como el idioma predeterminado de la aplicación.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.useAppLanguage();

useEmulator

Instrumenta tu aplicación para que se comunique con el emulador de autenticación.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.useEmulator({} as UseEmulatorOptions);

verifyBeforeUpdateEmail

Verifica la nueva dirección de correo electrónico antes de actualizar la dirección de correo electrónico del usuario actualmente conectado.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.verifyBeforeUpdateEmail({} as VerifyBeforeUpdateEmailOptions);

checkAppTrackingTransparencyPermission

Verifica el estado actual de la transparencia de seguimiento de la aplicación.

Sólo disponible en iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.checkAppTrackingTransparencyPermission();

requestAppTrackingTransparencyPermission

Abre el diálogo del sistema para autorizar la transparencia de seguimiento de la aplicación.

Atención: El usuario puede haber deshabilitado la solicitud de seguimiento en los ajustes del dispositivo, consulte la documentación de Apple.

Solo disponible en iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.requestAppTrackingTransparencyPermission();

Referencia de tipos

ApplyActionCodeOptions

export interface ApplyActionCodeOptions {
  /**
   * A verification code sent to the user.
   *
   * @since 0.2.2
   */
  oobCode: string;
}

ConfirmPasswordResetOptions

export interface ConfirmPasswordResetOptions {
  /**
   * A verification code sent to the user.
   *
   * @since 0.2.2
   */
  oobCode: string;
  /**
   * The new password.
   *
   * @since 0.2.2
   */
  newPassword: string;
}

ConfirmVerificationCodeOptions

export interface ConfirmVerificationCodeOptions {
  /**
   * The verification ID received from the `phoneCodeSent` listener.
   *
   * The `verificationCode` option must also be provided.
   *
   * @since 5.0.0
   */
  verificationId: string;
  /**
   * The verification code either received from the `phoneCodeSent` listener or entered by the user.
   *
   * The `verificationId` option must also be provided.
   *
   * @since 5.0.0
   */
  verificationCode: string;
}

SignInResult

export interface SignInResult {
  /**
   * The currently signed-in user, or null if there isn't any.
   *
   * @since 0.1.0
   */
  user: User | null;
  /**
   * Credentials returned by an auth provider.
   *
   * @since 0.1.0
   */
  credential: AuthCredential | null;
  /**
   * Additional user information from a federated identity provider.
   *
   * @since 0.5.1
   */
  additionalUserInfo: AdditionalUserInfo | null;
}

CreateUserWithEmailAndPasswordOptions

export interface CreateUserWithEmailAndPasswordOptions {
  /**
   * @since 0.2.2
   */
  email: string;
  /**
   * @since 0.2.2
   */
  password: string;
}

FetchSignInMethodsForEmailOptions

export interface FetchSignInMethodsForEmailOptions {
  /**
   * The user's email address.
   *
   * @since 6.0.0
   */
  email: string;
}

FetchSignInMethodsForEmailResult

export interface FetchSignInMethodsForEmailResult {
  /**
   * The sign-in methods for the specified email address.
   *
   * This list is empty when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)
   * is enabled, irrespective of the number of authentication methods available for the given email.
   *
   * @since 6.0.0
   */
  signInMethods: string[];
}

GetCurrentUserResult

export interface GetCurrentUserResult {
  /**
   * The currently signed-in user, or null if there isn't any.
   *
   * @since 0.1.0
   */
  user: User | null;
}

GetIdTokenOptions

export interface GetIdTokenOptions {
  /**
   * Force refresh regardless of token expiration.
   *
   * @since 0.1.0
   */
  forceRefresh: boolean;
}

GetIdTokenResult

export interface GetIdTokenResult {
  /**
   * The Firebase Auth ID token JWT string.
   *
   * @since 0.1.0
   */
  token: string;
}

GetIdTokenResultOptions

export interface GetIdTokenResultOptions {
  /**
   * Force refresh regardless of token expiration.
   *
   * @since 7.4.0
   */
  forceRefresh: boolean;
}

GetIdTokenResultResult

export interface GetIdTokenResultResult {
  /**
   * The authentication time in milliseconds since the epoch.
   *
   * This is the time the user authenticated (signed in) and not the time the token was refreshed.
   *
   * @since 7.4.0
   */
  authTime: number;
  /**
   * The ID token expiration time in milliseconds since the epoch.
   *
   * @since 7.4.0
   */
  expirationTime: number;
  /**
   * The ID token issuance time in milliseconds since the epoch.
   *
   * @since 7.4.0
   */
  issuedAtTime: number;
  /**
   * The sign-in provider through which the ID token was obtained.
   *
   * @since 7.4.0
   */
  signInProvider: string | null;
  /**
   * The type of second factor associated with this session, provided the user was multi-factor
   * authenticated (eg. phone, etc).
   *
   * @since 7.4.0
   */
  signInSecondFactor: string | null;
  /**
   * The entire payload claims of the ID token including the standard reserved claims as well as
   * the custom claims.
   *
   * @since 7.4.0
   */
  claims: Record<string, unknown>;
}

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.ts. Re-ejecuta la sincronización cuando los archivos públicos API cambian en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la autenticación y los flujos de cuenta, conecta con @capgo/capacitor-login-social para obtener detalles de implementación en @capgo/capacitor-login-social, @capgo/capacitor-clave-llave para obtener detalles de implementación en @capgo/capacitor-clave-llave, @capgo/capacitor-biometría-nativa para el detalle de implementación en @capgo/capacitor-biométrica nativa, Autenticación en dos factores para el detalle de implementación en Autenticación en dos factores, y SSO (Empresas) para el detalle de implementación en SSO (Empresas).