Interfaz que representa el servicio de Firebase Auth.
Consulta Firebase Authentication para obtener una guía completa sobre cómo utilizar el servicio de Firebase Auth.
Firma:
export interface Auth
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| app | App de Firebase | La FirebaseApp asociada con la instancia de servicio Auth. |
| config | Configuración | La configuración que se usó para inicializar esta instancia. |
| Usuario actual | Usuario | nulo | El usuario que accedió (o nulo) |
| emulatorConfig. | EmulatorConfig | nulo | La configuración actual del emulador (o nulo). |
| códigodeidioma | cadena | nulo | El código de idioma de la instancia Auth. |
| name | string | El nombre de la app asociada con la instancia de servicio Auth. |
| configuración | AuthSettings | La configuración de la instancia Auth. |
| IDdeusuario | cadena | nulo | El ID de usuario de la instancia de Auth. |
Métodos
| Método | Descripción |
|---|---|
| authStateReady() | devuelve una promesa que se resuelve de inmediato 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 salió de la cuenta. |
| 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 configure un usuario nuevo. |
| onAuthStateChanged(nextOrObserver, error, completed) | Agrega un observador para los cambios en el estado de acceso del usuario. |
| onIdTokenChanged(nextOrObserver, error, complete) | Agrega un observador para los cambios en el token de ID del usuario que accedió. |
| setPersistencia(persistencia) | Cambia el tipo de persistencia en la instancia Auth. |
| signOut(). | Sale del usuario actual. Esto no revoca automáticamente el token de ID del usuario. |
| updateCurrentUser(usuario) | Establece de forma asíncrona al usuario proporcionado como Auth.currentUser en la instancia de Auth. |
| UsarDeviceLanguage() | Establece el idioma actual en la preferencia predeterminada de dispositivo o navegador. |
Auth.app
La FirebaseApp asociada con la instancia de servicio Auth.
Firma:
readonly app: FirebaseApp;
Configuración de autenticación
La configuración que se usó para inicializar esta instancia.
Firma:
readonly config: Config;
Usuario actual de autenticación
El usuario que accedió (o nulo)
Firma:
readonly currentUser: User | null;
Auth.emulatorConfig
La configuración actual del emulador (o nulo).
Firma:
readonly emulatorConfig: EmulatorConfig | null;
Código de idioma de autenticación
El código de idioma de la instancia Auth.
Esta es una propiedad que admite escritura y lectura. Cuando se configura como 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 la contraseña, verificación de correo electrónico y revocación de cambios de correo electrónico), plantillas de SMS para la autenticación telefónica, el verificador reCAPTCHA y las operaciones de ventana emergente o redireccionamiento de OAuth, siempre que los proveedores especificados admitan la localización con el código de idioma especificado.
Firma:
languageCode: string | null;
Nombre de la autenticación
El nombre de la app asociada con la instancia de servicio Auth.
Firma:
readonly name: string;
Configuración de autenticación
La configuración de la instancia Auth.
Se usa para editar o leer opciones de configuración relacionadas, como el modo de verificación de apps para la autenticación por teléfono.
Firma:
readonly settings: AuthSettings;
IDdeusuario.Auth
El ID del usuario de la instancia de Auth.
Esta es una propiedad que admite escritura y lectura. Cuando configuras el ID de usuario de una instancia de Auth, todas las operaciones futuras de acceso o registro pasarán este ID y accederán o registrarán usuarios en el proyecto de usuario especificado. Cuando se establece como nula, los usuarios acceden al proyecto superior.
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 de inmediato 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 salió de la cuenta.
Firma:
authStateReady(): Promise<void>;
Muestra:
Promesa<void>
Auth.beforeAuthStateChanged()
Agrega una devolución de llamada de bloqueo que se ejecuta antes de que un cambio de estado de autenticación configure un usuario nuevo.
Firma:
beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| callback | (usuario: Usuario | nulo) => void | Promesa<void> | Se activa la devolución de llamada antes de que se establezca el valor de usuario nuevo. Si esto se arroja, se bloqueará al usuario para que no se configure. |
| OnAbort | () => anular | La devolución de llamada se activa si se genera una devolución de llamada beforeAuthStateChanged() posterior, lo que te permite deshacer los efectos secundarios. |
Muestra:
Auth.onAuthStateChanged()
Agrega un observador para los cambios en el estado de acceso del usuario.
Para mantener el comportamiento anterior, consulta Auth.onIdTokenChanged().
Firma:
onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nextOrObserver | NextOrObserver<Usuario | null> | se activa la devolución de llamada al realizar un cambio. |
| error | ErrorFn | Obsoleto. Esta devolución de llamada nunca se activa. Los errores de acceso y salida pueden capturarse en las promesas que se muestran cuando se usan las funciones para acceder y salir. |
| finalizado | Fn.completo | Obsoleto. Esta devolución de llamada nunca se activa. |
Muestra:
Auth.onIdTokenChanged()
Agrega un observador para los cambios en el token de ID del usuario que accedió.
Esto incluye eventos de acceso, cierre de sesión y actualización de token.
Firma:
onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nextOrObserver | NextOrObserver<Usuario | null> | se activa la devolución de llamada cuando se realiza un cambio. |
| error | ErrorFn | Obsoleto. Esta devolución de llamada nunca se activa. Los errores de acceso y salida pueden capturarse en las promesas que se muestran cuando se usan las funciones para acceder y salir. |
| finalizado | Fn completo | Obsoleto. Esta devolución de llamada nunca se activa. |
Muestra:
Auth.setPersistencia()
Cambia el tipo de persistencia en la instancia Auth.
Esto afectará la sesión de Auth guardada actualmente y aplica este tipo de persistencia para las solicitudes de acceso futuras, incluido el acceso con solicitudes de redireccionamiento.
De esta forma, es más fácil para un usuario que acceda especificar si su sesión debe recordarse o no. También facilita que nunca conserve el estado de autenticación de las aplicaciones que comparten otros usuarios o que tienen datos sensibles.
Este método no funciona en un entorno de Node.js.
Firma:
setPersistence(persistence: Persistence): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| persistencia | Persistencia | La persistencia que se usará. |
Muestra:
Promesa<void>
Ejemplo
auth.setPersistence(browserSessionPersistence);
Auth.signOut()
Sale del usuario actual. Esto no revoca automáticamente el token de ID del usuario.
Este método no es compatible con las instancias Auth creadas con una FirebaseServerApp.
Firma:
signOut(): Promise<void>;
Muestra:
Promesa<void>
Auth.updateCurrentUser()
Establece de forma asíncrona al usuario proporcionado como Auth.currentUser en la instancia de Auth.
Se creará una nueva copia de instancia del usuario proporcionada y se establecerá como currentUser.
Esto activará los objetos de escucha Auth.onAuthStateChanged() y Auth.onIdTokenChanged(), como otros métodos de acceso.
La operación falla con un error si el usuario que se actualizará pertenece a otro proyecto de Firebase.
Firma:
updateCurrentUser(user: User | null): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| usuario | Usuario | nulo | El usuario nuevo |
Muestra:
Promesa<void>
Auth.useDeviceLanguage()
Establece el idioma actual en la preferencia predeterminada de dispositivo o navegador.
Firma:
useDeviceLanguage(): void;
Muestra:
void