Una cuenta de usuario.
Signature:
export interface User extends UserInfo
Extiende: UserInfo
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| emailVerified | boolean | Si el correo electrónico se verificó con sendEmailVerification() y applyActionCode(). |
| isAnonymous | boolean | Indica si el usuario se autenticó con el proveedor ProviderId.ANONYMOUS. |
| metadata | UserMetadata | Metadatos adicionales sobre los tiempos de acceso y creación de los usuarios. |
| providerData | UserInfo | Adicional por proveedor, como displayName y la información de perfil. |
| refreshToken | cadena | El token de actualización que se usa para volver a autenticar al usuario. Evita usar esto directamente y prefiere que User.getIdToken() actualice el token de ID. |
| tenantId | cadena | nulo | El ID de usuario del usuario. |
Métodos
| Método | Descripción |
|---|---|
| delete() | Borra al usuario y luego cierra su sesión. |
| getIdToken(forceRefresh) | Devuelve un token web JSON (JWT) que se usa para identificar al usuario en un servicio de Firebase. |
| getIdTokenResult(forceRefresh) | Muestra un token web JSON (JWT) deserializado que se usa para identificar al usuario en un servicio de Firebase. |
| volver a cargar() | Actualiza el usuario, si accedió. |
| toJSON() | Muestra una representación serializable en JSON de este objeto. |
User.emailVerified
Si el correo electrónico se verificó con sendEmailVerification() y applyActionCode().
Signature:
readonly emailVerified: boolean;
User.isAnonymous
Indica si el usuario se autenticó con el proveedor ProviderId.ANONYMOUS.
Signature:
readonly isAnonymous: boolean;
User.metadata
Metadatos adicionales sobre los tiempos de acceso y creación de los usuarios.
Signature:
readonly metadata: UserMetadata;
User.providerData
Adicional por proveedor, como displayName y la información de perfil.
Signature:
readonly providerData: UserInfo[];
User.refreshToken
El token de actualización que se usa para volver a autenticar al usuario. Evita usar esto directamente y prefiere que User.getIdToken() actualice el token de ID.
Signature:
readonly refreshToken: string;
User.tenantId
El ID de usuario del usuario.
Esta es una propiedad de solo lectura, que indica el ID de usuario que se usa para que el usuario acceda. Este valor es nulo si el usuario accede desde el proyecto principal.
Signature:
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 al usuario y luego cierra su sesión.
Este método no es compatible con ningún usuario que haya accedido a través de instancias de Auth creadas con FirebaseServerApp.
Signature:
delete(): Promise<void>;
Devuelve:
Promise<void>
User.getIdToken()
Devuelve un token web JSON (JWT) que se usa para identificar al usuario en un servicio de Firebase.
Muestra el token actual si no ha vencido o si no vencerá en los próximos cinco minutos. De lo contrario, se actualizará el token y se mostrará uno nuevo.
Signature:
getIdToken(forceRefresh?: boolean): Promise<string>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| forceRefresh | boolean | Fuerza la actualización independientemente del vencimiento del token. |
Devuelve:
Promesa<string>
User.getIdTokenResult()
Muestra un token web JSON (JWT) deserializado que se usa para identificar al usuario en un servicio de Firebase.
Muestra el token actual si no ha vencido o si no vencerá en los próximos cinco minutos. De lo contrario, se actualizará el token y se mostrará uno nuevo.
Signature:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| forceRefresh | boolean | Fuerza la actualización independientemente del vencimiento del token. |
Devuelve:
Promise<IdTokenResult>
User.reload()
Actualiza el usuario, si accedió.
Signature:
reload(): Promise<void>;
Devuelve:
Promise<void>
User.toJSON()
Muestra una representación serializable en JSON de este objeto.
Signature:
toJSON(): object;
Devuelve:
objeto
Una representación serializable en JSON de este objeto.