Una cuenta de usuario
Firma:
export interface User extends UserInfo
Extiende: UserInfo
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| emailVerified | booleano | Indica si el correo electrónico se verificó con sendEmail Verification() y applyActionCode(). |
| esAnónimo | booleano | Indica si el usuario se autenticó con el proveedor ProviderId.ANONYMOUS. |
| metadata | UserMetadata | Metadatos adicionales sobre las horas de creación y de acceso de los usuarios. |
| Datos de proveedores | Información del usuario | Adicional por proveedor, como displayName y la información de perfil |
| refreshToken | string | Token de actualización que se usa para volver a autenticar al usuario. Evita usarlo directamente y opta por que User.getIdToken() actualice el token de ID. |
| IDdeusuario | cadena | nulo | El ID de usuario del usuario. |
Métodos
| Método | Descripción |
|---|---|
| delete() | Borra el usuario y sale de su cuenta. |
| getIdToken(forceRefresh) | Muestra un token web JSON (JWT) que se usa para identificar al usuario en un servicio de Firebase. |
| getIdTokenResult(forceRefresh) | Devuelve un token web JSON (JWT) deserializado que se usa para identificar al usuario en un servicio de Firebase. |
| reload() | Actualiza el usuario, si accedió. |
| toJSON() | Muestra una representación JSON serializable de este objeto. |
Usuario.emailVerified
Indica si el correo electrónico se verificó con sendEmail Verification() y applyActionCode().
Firma:
readonly emailVerified: boolean;
Usuario.isAnónimo
Indica si el usuario se autenticó con el proveedor ProviderId.ANONYMOUS.
Firma:
readonly isAnonymous: boolean;
Metadatos de usuario
Metadatos adicionales sobre las horas de creación y de acceso de los usuarios.
Firma:
readonly metadata: UserMetadata;
Usuario.providerData
Adicional por proveedor, como displayName y la información de perfil
Firma:
readonly providerData: UserInfo[];
User.refreshToken
Token de actualización que se usa para volver a autenticar al usuario. Evita usarlo directamente y opta por que User.getIdToken() actualice el token de ID.
Firma:
readonly refreshToken: string;
ID de usuario.
El ID de usuario del usuario.
Esta es una propiedad de solo lectura, que indica el ID de usuario que se usó para que el usuario acceda. Este valor será nulo si el usuario accedió desde el proyecto superior.
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'.
User.delete()
Borra el usuario y sale de su cuenta.
Este método no es compatible con ninguna instancia de User que haya accedido a una instancia de Auth creada con una FirebaseServerApp.
Firma:
delete(): Promise<void>;
Muestra:
Promesa<void>
User.getIdToken()
Muestra un token web JSON (JWT) que se usa para identificar al usuario en un servicio de Firebase.
Devuelve el token actual si no ha caducado o si no vencerá en los próximos cinco minutos. De lo contrario, se actualizará el token y se mostrará uno nuevo.
Firma:
getIdToken(forceRefresh?: boolean): Promise<string>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| forzar la actualización | booleano | Fuerza la actualización sin importar el vencimiento del token. |
Muestra:
Promesa<string>
User.getIdTokenResult()
Devuelve un token web JSON (JWT) deserializado que se usa para identificar al usuario en un servicio de Firebase.
Devuelve el token actual si no ha caducado o si no vencerá en los próximos cinco minutos. De lo contrario, se actualizará el token y se mostrará uno nuevo.
Firma:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| forzar la actualización | booleano | Fuerza la actualización sin importar el vencimiento del token. |
Muestra:
Promesa<IdTokenResult>
User.reload()
Actualiza el usuario, si accedió.
Firma:
reload(): Promise<void>;
Muestra:
Promesa<void>
User.toJSON()
Muestra una representación JSON serializable de este objeto.
Firma:
toJSON(): object;
Muestra:
objeto
Una representación JSON serializable de este objeto.