Uma conta de usuário.
Assinatura:
export interface User extends UserInfo
Estende: UserInfo
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| emailVerified (em inglês) | booleano | Se o e-mail foi verificado com sendEmail Verification() e applyActionCode(). |
| isAnonymous (link em inglês) | booleano | Indica se o usuário é autenticado usando o provedor ProviderId.ANONYMOUS. |
| metadata | UserMetadata (em inglês) | Metadados adicionais sobre a criação do usuário e os horários de login. |
| providerData (em inglês) | UserInfo[] | Adicional por provedor, como displayName e informações de perfil. |
| refreshToken (link em inglês) | string | Token de atualização usado para reautenticar o usuário. Evite usar isso diretamente e prefira User.getIdToken() para atualizar o token de ID. |
| tenantId (em inglês) | string | nulo | O ID de locatário do usuário. |
Métodos
| Método | Descrição |
|---|---|
| excluir(); | Exclui e desconecta o usuário. |
| getIdToken(forceRefresh) (em inglês) | Retorna um JSON Web Token (JWT) usado para identificar o usuário em um serviço do Firebase. |
| getIdTokenResult(forceRefresh) (em inglês) | Retorna um JSON Web Token (JWT) desserializado usado para identificar o usuário para um serviço do Firebase. |
| reload(). | Atualiza o usuário, se ele estiver conectado. |
| toJSON() (link em inglês) | Retorna uma representação serializável do JSON desse objeto. |
User.emailVerified
Se o e-mail foi verificado com sendEmail Verification() e applyActionCode().
Assinatura:
readonly emailVerified: boolean;
Usuário.isAnônimo
Indica se o usuário é autenticado usando o provedor ProviderId.ANONYMOUS.
Assinatura:
readonly isAnonymous: boolean;
Metadados do usuário
Metadados adicionais sobre a criação do usuário e os horários de login.
Assinatura:
readonly metadata: UserMetadata;
User.providerData
Adicional por provedor, como displayName e informações de perfil.
Assinatura:
readonly providerData: UserInfo[];
User.refreshToken
Token de atualização usado para reautenticar o usuário. Evite usar isso diretamente e prefira User.getIdToken() para atualizar o token de ID.
Assinatura:
readonly refreshToken: string;
User.tenantId
O ID de locatário do usuário.
Essa é uma propriedade somente leitura, que indica o ID de locatário usado para fazer o login do usuário. Esse valor será nulo se o usuário tiver feito login 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'.
User.delete()
Exclui e desconecta o usuário.
Esse método não tem suporte em nenhum User conectado por instâncias do Auth criadas com um FirebaseServerApp.
Assinatura:
delete(): Promise<void>;
Retorna:
Promessa<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 ele 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.
Assinatura:
getIdToken(forceRefresh?: boolean): Promise<string>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| forceRefresh | booleano | 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 para um serviço do Firebase.
Retorna o token atual se ele 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.
Assinatura:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| forceRefresh | booleano | Forçar a atualização, independentemente da expiração do token. |
Retorna:
Promessa<IdTokenResult>
User.reload().
Atualiza o usuário, se ele estiver conectado.
Assinatura:
reload(): Promise<void>;
Retorna:
Promessa<void>
User.toJSON()
Retorna uma representação serializável do JSON desse objeto.
Assinatura:
toJSON(): object;
Retorna:
objeto
Uma representação serializável do JSON desse objeto.