Interfaz que representa el servicio Firebase Auth.
Consulte Autenticación de Firebase para obtener una guía completa sobre cómo utilizar el servicio Firebase Auth.
Firma:
export interface Auth
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación Firebase | La FirebaseApp asociada con la instancia del servicio Auth . |
| configuración | configuración | La configuración utilizada para inicializar esta instancia. |
| usuario actual | Usuario | nulo | El usuario que ha iniciado sesión actualmente (o nulo). |
| configuración del emulador | Configuración del emulador | nulo | La configuración actual del emulador (o nula). |
| Código de lenguaje | cadena | nulo | El código de idioma de la instancia de autenticación . |
| nombre | cadena | El nombre de la aplicación asociada con la instancia del servicio Auth . |
| ajustes | Configuración de autenticación | La configuración de la instancia de autenticación . |
| ID de inquilino | cadena | nulo | El ID del inquilino de la instancia de autenticación . |
Métodos
| Método | Descripción |
|---|---|
| authStateReady() | devuelve una promesa que se resuelve inmediatamente cuando se establece el estado de autenticación inicial. Cuando se resuelve la promesa, el usuario actual puede ser un usuario válido o null si el usuario cerró sesión. |
| beforeAuthStateChanged(devolución de llamada, onAbort) | Agrega una devolución de llamada de bloqueo que se ejecuta antes de que un cambio de estado de autenticación establezca un nuevo usuario. |
| onAuthStateChanged(nextOrObserver, error, completado) | Agrega un observador para los cambios en el estado de inicio de sesión del usuario. |
| onIdTokenChanged(nextOrObserver, error, completado) | Agrega un observador para los cambios en el token de identificación del usuario que inició sesión. |
| setPersistence(persistencia) | Cambia el tipo de persistencia en la instancia Auth . |
| desconectar() | Cierra la sesión del usuario actual. Esto no revoca automáticamente el token de identificación del usuario. |
| actualizarUsuarioActual(usuario) | Establece de forma asincrónica el usuario proporcionado como Auth.currentUser en la instancia de Auth . |
| utilizarDeviceLanguage() | Establece el idioma actual según la preferencia predeterminada del dispositivo/navegador. |
Auth.app
La FirebaseApp asociada con la instancia del servicio Auth .
Firma:
readonly app: FirebaseApp;
autenticación.config
La configuración utilizada para inicializar esta instancia.
Firma:
readonly config: Config;
Usuario actual de autenticación
El usuario que ha iniciado sesión actualmente (o nulo).
Firma:
readonly currentUser: User | null;
Auth.emulatorConfig
La configuración actual del emulador (o nula).
Firma:
readonly emulatorConfig: EmulatorConfig | null;
Código de idioma de autenticación
El código de idioma de la instancia de autenticación .
Esta es una propiedad legible/escribible. Cuando se establece en nulo, se aplica la configuración de idioma predeterminada de Firebase Console. El código de idioma se propagará a las plantillas de acción de correo electrónico (restablecimiento de contraseña, verificación de correo electrónico y revocación de cambio de correo electrónico), plantillas de SMS para autenticación telefónica, verificador reCAPTCHA y operaciones de redireccionamiento/ventana emergente de OAuth, siempre que los proveedores especificados admitan la localización con el código de idioma especificado.
Firma:
languageCode: string | null;
nombre.auth.
El nombre de la aplicación asociada con la instancia del servicio Auth .
Firma:
readonly name: string;
Configuración de autenticación
La configuración de la instancia de autenticación .
Esto se utiliza para editar/leer opciones relacionadas con la configuración, como el modo de verificación de aplicaciones para la autenticación del teléfono.
Firma:
readonly settings: AuthSettings;
Auth.tenantId
El ID del inquilino de la instancia de autenticación .
Esta es una propiedad legible/escribible. Cuando configura el ID de inquilino de una instancia de autenticación , todas las operaciones futuras de inicio de sesión/registro pasarán este ID de inquilino e iniciarán sesión o registrarán usuarios en el proyecto de inquilino especificado. Cuando se establece en nulo, los usuarios inician sesión en el proyecto principal.
Firma:
tenantId: string | null;
Ejemplo
// Set the tenant ID on Auth instance.
auth.tenantId = 'TENANT_PROJECT_ID';
// All future sign-in request now include tenant ID.
const result = await signInWithEmailAndPassword(auth, email, password);
// result.user.tenantId should be 'TENANT_PROJECT_ID'.
Auth.authStateReady()
devuelve una promesa que se resuelve inmediatamente cuando se establece el estado de autenticación inicial. Cuando se resuelve la promesa, el usuario actual puede ser un usuario válido o null si el usuario cerró sesión.
Firma:
authStateReady(): Promise<void>;
Devoluciones:
Promesa<nulo>
Auth.beforeAuthStateChanged()
Agrega una devolución de llamada de bloqueo que se ejecuta antes de que un cambio de estado de autenticación establezca un nuevo usuario.
Firma:
beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| llamar de vuelta | (usuario: Usuario | nulo) => nulo | Promesa<nulo> | devolución de llamada activada antes de que se establezca el nuevo valor de usuario. Si esto arroja, bloquea la configuración del usuario. |
| onAbort | () => nulo | La devolución de llamada se activa si se produce una devolución de llamada posterior beforeAuthStateChanged() , lo que le permite deshacer cualquier efecto secundario. |
Devoluciones:
Auth.onAuthStateChanged()
Agrega un observador para los cambios en el estado de inicio de sesión del usuario.
Para mantener el comportamiento anterior, consulte Auth.onIdTokenChanged() .
Firma:
onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| siguienteOrObserver | SiguienteOrObserver < Usuario | nulo> | devolución de llamada activada en caso de cambio. |
| error | ErrorFn | Obsoleto. Esta devolución de llamada nunca se activa. Los errores al iniciar/cerrar sesión pueden detectarse en las promesas devueltas por las funciones de inicio/cierre de sesión. |
| terminado | CompletaFn | Obsoleto. Esta devolución de llamada nunca se activa. |
Devoluciones:
Auth.onIdTokenChanged()
Agrega un observador para los cambios en el token de identificación del usuario que inició sesión.
Esto incluye eventos de inicio de sesión, cierre de sesión y actualización de tokens.
Firma:
onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| siguienteOrObserver | SiguienteOrObserver < Usuario | nulo> | devolución de llamada activada en caso de cambio. |
| error | ErrorFn | Obsoleto. Esta devolución de llamada nunca se activa. Los errores al iniciar/cerrar sesión pueden detectarse en las promesas devueltas por las funciones de inicio/cierre de sesión. |
| terminado | CompletaFn | Obsoleto. Esta devolución de llamada nunca se activa. |
Devoluciones:
Auth.setPersistence()
Cambia el tipo de persistencia en la instancia Auth .
Esto afectará la sesión de autenticación guardada actualmente y aplica este tipo de persistencia para futuras solicitudes de inicio de sesión, incluido el inicio de sesión con solicitudes de redireccionamiento.
Esto facilita que un usuario que inicia sesión especifique si su sesión debe recordarse o no. También hace que sea más fácil no conservar nunca el estado de autenticación para aplicaciones que son compartidas por otros usuarios o que tienen datos confidenciales.
Este método no funciona en un entorno Node.js.
Firma:
setPersistence(persistence: Persistence): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| persistencia | Persistencia | La persistencia al uso. |
Devoluciones:
Promesa<nulo>
Ejemplo
auth.setPersistence(browserSessionPersistence);
Auth.signOut()
Cierra la sesión del usuario actual. Esto no revoca automáticamente el token de identificación del usuario.
Firma:
signOut(): Promise<void>;
Devoluciones:
Promesa<nulo>
Auth.updateCurrentUser()
Establece de forma asincrónica el usuario proporcionado como Auth.currentUser en la instancia de Auth .
Se creará una nueva copia de instancia del usuario proporcionado y se establecerá como usuario actual.
Esto activará los oyentes Auth.onAuthStateChanged() y Auth.onIdTokenChanged() al igual que otros métodos de inicio de sesión.
La operación falla con un error si el usuario que se va a actualizar pertenece a un proyecto de Firebase diferente.
Firma:
updateCurrentUser(user: User | null): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| usuario | Usuario | nulo | El nuevo usuario . |
Devoluciones:
Promesa<nulo>
Auth.useDeviceLanguage()
Establece el idioma actual según la preferencia predeterminada del dispositivo/navegador.
Firma:
useDeviceLanguage(): void;
Devoluciones:
vacío