User interface

Una cuenta de usuario.

Firma:

export interface User extends UserInfo

Extiende: Información de usuario

Propiedades

Propiedad Tipo Descripción
Correo Electrónico Verificado booleano Si el correo electrónico se ha verificado con sendEmailVerification() y applyActionCode() .
es anónimo booleano Si el usuario está autenticado mediante ProviderId .Proveedor ANÓNIMO.
metadatos Metadatos de usuario Metadatos adicionales sobre la creación de usuarios y los tiempos de inicio de sesión.
proveedorDatos Información de usuario [] Adicional por proveedor, como nombre para mostrar e información de perfil.
actualizarToken cadena Token de actualización utilizado para volver a autenticar al usuario. Evite usar esto directamente y prefiera User.getIdToken() para actualizar el token de identificación.
ID de inquilino cadena | nulo El ID del inquilino del usuario.

Métodos

Método Descripción
borrar() Elimina y cierra la sesión del usuario.
getIdToken(fuerzaRefresh) Devuelve un token web JSON (JWT) utilizado para identificar al usuario en un servicio de Firebase.
getIdTokenResult(fuerzaRefresh) Devuelve un token web JSON (JWT) deserializado que se utiliza para identificar al usuario en un servicio de Firebase.
recargar() Actualiza al usuario, si ha iniciado sesión.
a JSON() Devuelve una representación serializable JSON de este objeto.

User.emailVerificado

Si el correo electrónico se ha verificado con sendEmailVerification() y applyActionCode() .

Firma:

readonly emailVerified: boolean;

Usuario.isAnonymous

Si el usuario está autenticado mediante ProviderId .Proveedor ANÓNIMO.

Firma:

readonly isAnonymous: boolean;

Usuario.metadatos

Metadatos adicionales sobre la creación de usuarios y los tiempos de inicio de sesión.

Firma:

readonly metadata: UserMetadata;

Usuario.proveedorDatos

Adicional por proveedor, como nombre para mostrar e información de perfil.

Firma:

readonly providerData: UserInfo[];

Usuario.refreshToken

Token de actualización utilizado para volver a autenticar al usuario. Evite usar esto directamente y prefiera User.getIdToken() para actualizar el token de identificación.

Firma:

readonly refreshToken: string;

Usuario.tenantId

El ID del inquilino del usuario.

Esta es una propiedad de solo lectura, que indica el ID del inquilino utilizado para iniciar sesión. Esto es nulo si el usuario inició sesión desde el proyecto principal.

Firma:

readonly 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'.

Usuario.eliminar()

Elimina y cierra la sesión del usuario.

Firma:

delete(): Promise<void>;

Devoluciones:

Promesa<nulo>

Usuario.getIdToken()

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

Devuelve el token actual si no ha caducado o si no caducará en los próximos cinco minutos. De lo contrario, esto actualizará el token y devolverá uno nuevo.

Firma:

getIdToken(forceRefresh?: boolean): Promise<string>;

Parámetros

Parámetro Tipo Descripción
forceRefresh booleano Forzar la actualización independientemente de la caducidad del token.

Devoluciones:

Promesa<cadena>

Usuario.getIdTokenResult()

Devuelve un token web JSON (JWT) deserializado que se utiliza para identificar al usuario en un servicio de Firebase.

Devuelve el token actual si no ha caducado o si no caducará en los próximos cinco minutos. De lo contrario, esto actualizará el token y devolverá uno nuevo.

Firma:

getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;

Parámetros

Parámetro Tipo Descripción
forceRefresh booleano Forzar la actualización independientemente de la caducidad del token.

Devoluciones:

Promesa< IdTokenResult >

Usuario.recargar()

Actualiza al usuario, si ha iniciado sesión.

Firma:

reload(): Promise<void>;

Devoluciones:

Promesa<nulo>

Usuario.toJSON()

Devuelve una representación serializable JSON de este objeto.

Firma:

toJSON(): object;

Devoluciones:

objeto

Una representación serializable en JSON de este objeto.