Auth interface

Interface que representa o serviço do Firebase Auth.

Consulte Firebase Authentication para um guia completo sobre como usar o serviço Firebase Auth.

Assinatura:

export interface Auth 

Propriedades

Métodos

Auth.app

O FirebaseApp associado à instância de serviço Auth.

Assinatura:

readonly app: FirebaseApp;

Auth.config

O Config usado para inicializar esta instância.

Assinatura:

readonly config: Config;

Auth.currentUser

O usuário conectado no momento (ou nulo).

Assinatura:

readonly currentUser: User | null;

Auth.EmulatorConfig

A configuração atual do emulador (ou nula).

Assinatura:

readonly emulatorConfig: EmulatorConfig | null;

Código de idioma

O código de idioma da instância Auth.

Esta é uma propriedade legível/gravável. Quando definido como nulo, a configuração de idioma padrão do Console do Firebase é aplicada. O código de idioma será propagado para modelos de ação de e-mail (redefinição de senha, verificação e revogação de alterações de e-mail), modelos de SMS para autenticação por telefone, verificador reCAPTCHA e operações de pop-up/redirecionamento do OAuth, desde que os provedores especificados ofereçam suporte à localização com o código de idioma especificado.

Assinatura:

languageCode: string | null;

Nome de autenticação

O nome do app associado à instância de serviço Auth.

Assinatura:

readonly name: string;

Auth.settings

As configurações da instância Auth.

É usado para editar/ler opções relacionadas à configuração, como o modo de verificação de apps para autenticação por telefone.

Assinatura:

readonly settings: AuthSettings;

Auth.tenantId

O ID de locatário da instância Auth.

Esta é uma propriedade legível/gravável. Quando você define o ID de locatário de uma instância Auth, todas as operações futuras de login/inscrição passam esse ID de locatário e inscrevem ou inscrevem usuários no projeto de locatário especificado. Quando definido como nulo, os usuários serão conectados ao projeto pai.

Assinatura:

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'.

Auth.authStateReady()

retorna uma promessa que é resolvida imediatamente quando o estado de autenticação inicial é resolvido. Quando a promessa for resolvida, o usuário atual poderá ser um usuário válido ou null se o usuário tiver saído.

Assinatura:

authStateReady(): Promise<void>;

Retorna:

Promessa<void>

Auth.beforeAuthStateChanged()

Adiciona um callback de bloqueio executado antes que uma mudança de estado de autenticação defina um novo usuário.

Assinatura:

beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

Parâmetros

Retorna:

Cancelar inscrição

Auth.onAuthStateChanged()

Adiciona um observador para alterações no estado de login do usuário.

Para manter o comportamento antigo, consulte Auth.onIdTokenChanged().

Assinatura:

onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Parâmetros

Retorna:

Cancelar inscrição

Auth.onIdTokenChanged()

Adiciona um observador para alterações no token de ID do usuário conectado.

Isso inclui eventos de login, logout e atualização de token.

Assinatura:

onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Parâmetros

Retorna:

Cancelar inscrição

Auth.setPersistent()

Muda o tipo de persistência na instância Auth.

Isso afetará a sessão do Auth salva atualmente e aplica esse tipo de persistência para futuras solicitações de login, incluindo login com solicitações de redirecionamento.

Isso faz com que seja mais fácil para o usuário que está fazendo login especificar se a sessão deve ser lembrada ou não. Isso também torna mais fácil nunca manter o estado do Auth para aplicativos que são compartilhados por outros usuários ou têm dados sensíveis.

Esse método não funciona em um ambiente Node.js.

Assinatura:

setPersistence(persistence: Persistence): Promise<void>;

Parâmetros

Retorna:

Promessa<void>

Exemplo

auth.setPersistence(browserSessionPersistence);

Auth.signOut()

Desconecta o usuário atual. Isso não revoga automaticamente o token de ID do usuário.

Este método não é compatível com instâncias do Auth criadas com um FirebaseServerApp.

Assinatura:

signOut(): Promise<void>;

Retorna:

Promessa<void>

Auth.updateCurrentUser()

Define de maneira assíncrona o usuário fornecido como Auth.currentUser na instância Auth.

Uma nova cópia da instância do usuário fornecido será feita e definida como currentUser.

Isso acionará os listeners Auth.onAuthStateChanged() e Auth.onIdTokenChanged() como outros métodos de login.

A operação falhará com um erro se o usuário a ser atualizado pertencer a um projeto diferente do Firebase.

Assinatura:

updateCurrentUser(user: User | null): Promise<void>;

Parâmetros

Retorna:

Promessa<void>

Auth.useDeviceLanguage()

Define o idioma atual como a preferência padrão de dispositivo/navegador.

Assinatura:

useDeviceLanguage(): void;

Retorna:

void