Auth interface

Interface que representa o serviço Firebase Auth.

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

Assinatura:

export interface Auth 

Propriedades

Métodos

Autenticação.app

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

Assinatura:

readonly app: FirebaseApp;

Autenticação.config

O Config usado para inicializar esta instância.

Assinatura:

readonly config: Config;

Autenticação.usuárioatual

O usuário atualmente conectado (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 autenticação

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 Firebase Console é aplicada. O código de idioma será propagado para modelos de ação de e-mail (redefinição de senha, verificação de e-mail e revogação de alteração de e-mail), modelos de SMS para autenticação de telefone, verificador reCAPTCHA e operações de pop-up/redirecionamento OAuth, desde que os provedores especificados suportem localização com o código de idioma especificado.

Assinatura:

languageCode: string | null;

Nome de autenticação

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

Assinatura:

readonly name: string;

Configurações de autenticação

As configurações da instância Auth .

Isso é usado para editar/ler opções relacionadas à configuração, como modo de verificação de aplicativo para autenticação de telefone.

Assinatura:

readonly settings: AuthSettings;

Auth.tenantId

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

Esta é uma propriedade legível/gravável. Quando você define o ID do locatário de uma instância Auth , todas as futuras operações de entrada/inscrição passarão esse ID do locatário e farão login ou inscreverão usuários no projeto de locatário especificado. Quando definido como nulo, os usuários estã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 retorno de chamada de bloqueio executado antes que uma alteração 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 subscriçã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 subscrição

Auth.onIdTokenChanged()

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

Isso inclui eventos de entrada, saída e atualização de token.

Assinatura:

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

Parâmetros

Retorna:

Cancelar subscrição

Auth.setPersistência()

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

Isto afetará a sessão de autenticação atualmente salva e aplicará esse tipo de persistência para solicitações de entrada futuras, incluindo entrada com solicitações de redirecionamento.

Isso torna mais fácil para um usuário que faz login especificar se sua sessão deve ser lembrada ou não. Também torna mais fácil nunca persistir o estado Auth para aplicativos que são compartilhados por outros usuários ou que possuem dados confidenciais.

Este 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);

Autenticação.signOut()

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

Assinatura:

signOut(): Promise<void>;

Retorna:

Promessa<void>

Auth.updateCurrentUser()

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

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

Isso acionará os ouvintes 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 para a preferência padrão do dispositivo/navegador.

Assinatura:

useDeviceLanguage(): void;

Retorna:

vazio