Interface que representa o serviço do Firebase Auth.
Consulte Firebase Authentication para ver um guia completo sobre como usar o serviço do Firebase Auth.
Signature:
export interface Auth
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
app | FirebaseApp | O FirebaseApp associado à instância de serviço Auth . |
config | Configuração | O Config usado para inicializar essa instância. |
currentUser | Usuário | nulo | O usuário conectado no momento (ou nulo). |
emulatorConfig | EmulatorConfig | nulo | A configuração atual do emulador (ou nula). |
languageCode | string | nulo | O código de idioma da instância Auth. |
name | string | O nome do aplicativo associado à instância de serviço Auth . |
configurações | AuthSettings | As configurações da instância Auth. |
tenantId | string | nulo | O ID do locatário da instância Auth. |
Métodos
Método | Descrição |
---|---|
authStateReady() | retorna uma promessa que é resolvida imediatamente quando o estado de autenticação inicial é definido. Quando a promessa for resolvida, o usuário atual poderá ser um válido ou null se tiver saído da sessão. |
beforeAuthStateChanged(callback, onAbort) | Adiciona um callback de bloqueio que é executado antes de uma alteração de estado de autenticação definir um novo usuário. |
onAuthStateChanged(nextOrObserver, error, completed) | Adiciona um observador para mudanças no estado de login do usuário. |
onIdTokenChanged(nextOrObserver, error, completed) | Adiciona um observador para mudanças no token de ID do usuário conectado. |
setPersistence(persistence) | Altera o tipo de persistência na instância Auth . |
signOut() | Desconecta o usuário atual. Isso não revoga automaticamente o token de ID do usuário. |
updateCurrentUser(user) | Define de maneira assíncrona o usuário fornecido como Auth.currentUser na instância Auth. |
useDeviceLanguage() | Define o idioma atual para a preferência padrão do dispositivo/navegador. |
Auth.app
O FirebaseApp associado à instância de serviço Auth
.
Signature:
readonly app: FirebaseApp;
Auth.config
O Config usado para inicializar essa instância.
Signature:
readonly config: Config;
Auth.currentUser
O usuário conectado no momento (ou nulo).
Signature:
readonly currentUser: User | null;
Auth.emulatorConfig
A configuração atual do emulador (ou nula).
Signature:
readonly emulatorConfig: EmulatorConfig | null;
Auth.languageCode
O código de idioma da instância Auth.
Essa é uma propriedade legível/gravável. Quando definido como nulo, a configuração de idioma padrão do Console do Firebase será 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 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 do idioma especificado.
Signature:
languageCode: string | null;
Auth.name
O nome do aplicativo associado à instância de serviço Auth
.
Signature:
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.
Signature:
readonly settings: AuthSettings;
Auth.tenantId
O ID do locatário da instância Auth.
Essa é uma propriedade legível/gravável. Quando você define o ID de locatário de uma instância Auth, todas as operações de login/inscrição futuras passam esse ID e fazem login ou inscrevem usuários no projeto de locatário especificado. Quando definido como nulo, os usuários fazem login no projeto pai.
Signature:
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 é definido. Quando a promessa for resolvida, o usuário atual poderá ser um válido ou null
se tiver saído da sessão.
Signature:
authStateReady(): Promise<void>;
Retorna:
Promise<void>
Auth.beforeAuthStateChanged()
Adiciona um callback de bloqueio que é executado antes de uma alteração de estado de autenticação definir um novo usuário.
Signature:
beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
callback | (user: User | null) => void | Promise<void> | callback acionado antes que o valor do novo usuário seja definido. Se isso for gerado, isso impedirá que o usuário seja definido. |
onAbort | () => nulo | callback acionado quando um callback beforeAuthStateChanged() posterior é gerado, permitindo desfazer efeitos colaterais |
Retorna:
Auth.onAuthStateChanged()
Adiciona um observador para mudanças no estado de login do usuário.
Para manter o comportamento antigo, consulte Auth.onIdTokenChanged().
Signature:
onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
nextOrObserver | NextOrObserver<User | null> | callback acionado na alteração. |
error | ErrorFn | Obsoleto. Esse callback nunca é acionado. Erros ao fazer login/sair podem ser detectados em promessas retornadas de funções de login/sair. |
concluída | CompleteFn | Obsoleto. Esse callback nunca é acionado. |
Retorna:
Auth.onIdTokenChanged()
Adiciona um observador para mudanças no token de ID do usuário conectado.
Isso inclui eventos de login, logout e atualização de token.
Signature:
onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
nextOrObserver | NextOrObserver<User | null> | callback acionado na alteração. |
error | ErrorFn | Obsoleto. Esse callback nunca é acionado. Erros ao fazer login/sair podem ser detectados em promessas retornadas de funções de login/sair. |
concluída | CompleteFn | Obsoleto. Esse callback nunca é acionado. |
Retorna:
Auth.setPersistence()
Altera o tipo de persistência na instância Auth
.
Isso vai afetar a sessão do Auth salva no momento e aplicar esse tipo de persistência nas próximas solicitações de login, inclusive no login com solicitações de redirecionamento.
Assim, o usuário que faz login pode especificar se a sessão deve ser lembrada ou não. Isso também facilita a persistência do estado do Auth em aplicativos compartilhados por outros usuários ou que têm dados confidenciais.
Este método não funciona em um ambiente Node.js.
Signature:
setPersistence(persistence: Persistence): Promise<void>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
persistência | Persistência | A Persistência a ser usada. |
Retorna:
Promise<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 Auth criadas com um FirebaseServerApp.
Signature:
signOut(): Promise<void>;
Retorna:
Promise<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á criada e definida como currentUser.
Isso acionará os listeners Auth.onAuthStateChanged() e Auth.onIdTokenChanged() da mesma forma que 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.
Signature:
updateCurrentUser(user: User | null): Promise<void>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
usuário | Usuário | nulo | O novo User. |
Retorna:
Promise<void>
Auth.useDeviceLanguage()
Define o idioma atual para a preferência padrão do dispositivo/navegador.
Signature:
useDeviceLanguage(): void;
Retorna:
void