Uma conta de usuário.
Assinatura:
export interface User extends UserInfo
Estende: UserInfo
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
email verificado | boleano | Se o email foi verificado com sendEmailVerification() e applyActionCode() . |
é anônimo | boleano | Se o usuário está autenticado usando o ProviderId Provedor .ANÔNIMO. |
metadados | UserMetadados | Metadados adicionais sobre criação de usuários e horários de login. |
provedorData | Informação de usuário [] | Adicional por provedor, como displayName e informações de perfil. |
atualizarToken | corda | Token de atualização usado para autenticar novamente o usuário. Evite usar isso diretamente e prefira User.getIdToken() para atualizar o token de ID. |
inquilinoId | corda | nulo | O ID do locatário do usuário. |
Métodos
Método | Descrição |
---|---|
excluir() | 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 em um serviço do Firebase. |
recarregar() | Atualiza o usuário, se estiver conectado. |
paraJSON() | Retorna uma representação serializável JSON deste objeto. |
Usuário.emailVerificado
Se o email foi verificado com sendEmailVerification() e applyActionCode() .
Assinatura:
readonly emailVerified: boolean;
Usuário.isAnonymous
Se o usuário está autenticado usando o ProviderId Provedor .ANÔNIMO.
Assinatura:
readonly isAnonymous: boolean;
Usuário.metadados
Metadados adicionais sobre criação de usuários e horários de login.
Assinatura:
readonly metadata: UserMetadata;
Usuário.providerData
Adicional por provedor, como displayName e informações de perfil.
Assinatura:
readonly providerData: UserInfo[];
Usuário.refreshToken
Token de atualização usado para autenticar novamente o usuário. Evite usar isso diretamente e prefira User.getIdToken() para atualizar o token de ID.
Assinatura:
readonly refreshToken: string;
Usuário.tenantId
O ID do locatário do usuário.
Esta é uma propriedade somente leitura, que indica o ID do locatário usado para conectar o usuário. Isso será nulo se o usuário estiver conectado no projeto pai.
Assinatura:
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'.
Usuário.delete()
Exclui e desconecta o usuário.
Assinatura:
delete(): Promise<void>;
Retorna:
Promessa<void>
Usuário.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, isso atualizará o token e retornará um novo.
Assinatura:
getIdToken(forceRefresh?: boolean): Promise<string>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
forçar atualização | boleano | 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 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, isso atualizará o token e retornará um novo.
Assinatura:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
forçar atualização | boleano | Forçar a atualização independentemente da expiração do token. |
Retorna:
Promessa< IdTokenResult >
Usuário.reload()
Atualiza o usuário, se estiver conectado.
Assinatura:
reload(): Promise<void>;
Retorna:
Promessa<void>
Usuário.toJSON()
Retorna uma representação serializável JSON deste objeto.
Assinatura:
toJSON(): object;
Retorna:
objeto
Uma representação serializável JSON deste objeto.