Uma conta de usuário.
Signature:
export interface User extends UserInfo
Estende: UserInfo
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
emailVerified | boolean | Indica se o e-mail foi verificado com sendEmailVerification() e applyActionCode(). |
isAnonymous | boolean | Se o usuário está autenticado usando o provedor ProviderId.ANONYMOUS. |
metadata | UserMetadata | Metadados adicionais sobre a criação do usuário e os horários de login. |
providerData | UserInfo[] | Adicional por provedor, como displayName e informações de perfil. |
refreshToken | string | Token de atualização usado para autenticar o usuário novamente. Evite usar isso diretamente e prefira User.getIdToken() para atualizar o token de ID. |
tenantId | string | nulo | O ID do locatário do usuário. |
Métodos
Método | Descrição |
---|---|
delete() | Exclui e desconecta o usuário. |
getIdToken(forceRefresh) | Retorna um JSON Web Token (JWT) usado para identificar o usuário em um serviço do Firebase. |
getIdTokenResult(forceRefresh) | Retorna um JSON Web Token (JWT) desserializado usado para identificar o usuário a um serviço do Firebase. |
reload() (link em inglês) | Atualiza o usuário, se ele estiver conectado. |
toJSON() | Retorna uma representação JSON serializável desse objeto. |
User.emailVerified
Indica se o e-mail foi verificado com sendEmailVerification() e applyActionCode().
Signature:
readonly emailVerified: boolean;
User.isAnonymous
Se o usuário está autenticado usando o provedor ProviderId.ANONYMOUS.
Signature:
readonly isAnonymous: boolean;
User.metadata
Metadados adicionais sobre a criação do usuário e os horários de login.
Signature:
readonly metadata: UserMetadata;
User.providerData
Adicional por provedor, como displayName e informações de perfil.
Signature:
readonly providerData: UserInfo[];
User.refreshToken
Token de atualização usado para autenticar o usuário novamente. Evite usar isso diretamente e prefira User.getIdToken() para atualizar o token de ID.
Signature:
readonly refreshToken: string;
User.tenantId
O ID do locatário do usuário.
Esta é uma propriedade somente leitura, que indica o ID do locatário usado para fazer o login do usuário. Será nulo se o usuário estiver conectado ao projeto pai.
Signature:
readonly tenantId: string | null;
Exemplo
// 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()
Exclui e desconecta o usuário.
Esse método não é aceito por qualquer User conectado por instâncias de Auth criadas com um FirebaseServerApp.
Signature:
delete(): Promise<void>;
Retorna:
Promise<void>
User.getIdToken()
Retorna um JSON Web Token (JWT) usado para identificar o usuário em um serviço do Firebase.
Retorna o token atual se não tiver expirado ou se não expirar nos próximos cinco minutos. Caso contrário, o token será atualizado e um novo será retornado.
Signature:
getIdToken(forceRefresh?: boolean): Promise<string>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
forceRefresh | boolean | Forçar a atualização, independentemente da expiração do token. |
Retorna:
Promessa<string>
User.getIdTokenResult()
Retorna um JSON Web Token (JWT) desserializado usado para identificar o usuário a um serviço do Firebase.
Retorna o token atual se não tiver expirado ou se não expirar nos próximos cinco minutos. Caso contrário, o token será atualizado e um novo será retornado.
Signature:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
forceRefresh | boolean | Forçar a atualização, independentemente da expiração do token. |
Retorna:
Promise<IdTokenResult>
User.reload()
Atualiza o usuário, se ele estiver conectado.
Signature:
reload(): Promise<void>;
Retorna:
Promise<void>
User.toJSON()
Retorna uma representação JSON serializável desse objeto.
Signature:
toJSON(): object;
Retorna:
objeto
Uma representação deste objeto que pode ser serializada em JSON.