Interfaccia che rappresenta il servizio Firebase Auth.
Consulta Firebase Authentication per una guida completa su come utilizzare il servizio Firebase Auth.
Firma:
export interface Auth
Proprietà
| Proprietà | Tipo | Descrizione |
|---|---|---|
| app | FirebaseApp | La risorsa FirebaseApp associata all'istanza del servizio Auth. |
| Configurazione | Configurazione | La configurazione utilizzata per inizializzare questa istanza. |
| currentUser | Utente | null | L'utente che ha eseguito l'accesso (o un valore nullo). |
| emulatorConfig | EmulatorConfig | null | La configurazione attuale dell'emulatore (o null). |
| languageCode | stringa | null | Il codice lingua dell'istanza Auth. |
| name | stringa | Il nome dell'app associata all'istanza del servizio Auth. |
| impostazioni | AuthSettings | Le impostazioni dell'istanza di Auth. |
| tenantId | stringa | null | L'ID tenant dell'istanza di Auth. |
Metodi
| Metodo | Descrizione |
|---|---|
| authStateReady() | restituisce una promessa che si risolve immediatamente quando viene definito lo stato di autenticazione iniziale. Quando la promessa viene risolta, l'utente corrente potrebbe essere un utente valido o null se l'utente si è disconnesso. |
| beforeAuthStateChanged(callback, onAbort) | Aggiunge un callback di blocco che viene eseguito prima che una modifica dello stato di autenticazione imposti un nuovo utente. |
| onAuthStateChanged(nextOrObserver, error, completed) | Aggiunge un osservatore per le modifiche allo stato di accesso dell'utente. |
| onIdTokenChanged(nextOrObserver, error, completed) | Aggiunge un osservatore per le modifiche al token ID dell'utente che ha eseguito l'accesso. |
| setPersistence(persistence) | Modifica il tipo di persistenza nell'istanza Auth. |
| signOut() | Disconnette l'utente corrente. Questa operazione non revoca automaticamente il token ID dell'utente. |
| updateCurrentUser(user) | Imposta in modo asincrono l'utente fornito come Auth.currentUser nell'istanza Auth. |
| useDeviceLanguage() | Imposta la lingua corrente sulla preferenza predefinita del dispositivo/browser. |
Auth.app
La risorsa FirebaseApp associata all'istanza del servizio Auth.
Firma:
readonly app: FirebaseApp;
Auth.config
La configurazione utilizzata per inizializzare questa istanza.
Firma:
readonly config: Config;
Auth.currentUser
L'utente che ha eseguito l'accesso (o un valore nullo).
Firma:
readonly currentUser: User | null;
Auth.emulatorConfig
La configurazione attuale dell'emulatore (o null).
Firma:
readonly emulatorConfig: EmulatorConfig | null;
Auth.languageCode
Il codice lingua dell'istanza Auth.
Questa è una proprietà leggibile/scrivibile. Se impostato su null, viene applicata l'impostazione predefinita della lingua della console Firebase. Il codice lingua verrà propagato ai modelli di azioni email (reimpostazione password, verifica email e revoca modifica email), ai modelli SMS per l'autenticazione telefonica, allo strumento di verifica reCAPTCHA e alle operazioni di popup/reindirizzamento OAuth, a condizione che i provider specificati supportino la localizzazione con il codice lingua specificato.
Firma:
languageCode: string | null;
Auth.name
Il nome dell'app associata all'istanza del servizio Auth.
Firma:
readonly name: string;
Auth.settings
Le impostazioni dell'istanza di Auth.
Viene utilizzato per modificare/leggere le opzioni relative alla configurazione, ad esempio la modalità di verifica delle app per l'autenticazione telefonica.
Firma:
readonly settings: AuthSettings;
Auth.tenantId
L'ID tenant dell'istanza di Auth.
Questa è una proprietà leggibile/scrivibile. Quando imposti l'ID tenant di un'istanza di Auth, tutte le future operazioni di accesso/registrazione passeranno questo ID tenant e faranno accedere o registrare gli utenti al progetto tenant specificato. Se il valore è impostato su null, gli utenti hanno eseguito l'accesso al progetto principale.
Firma:
tenantId: string | null;
Esempio
// 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()
restituisce una promessa che si risolve immediatamente quando viene definito lo stato di autenticazione iniziale. Quando la promessa viene risolta, l'utente corrente potrebbe essere un utente valido o null se l'utente si è disconnesso.
Firma:
authStateReady(): Promise<void>;
Resi:
Promise<void>
Auth.beforeAuthStateChanged()
Aggiunge un callback di blocco che viene eseguito prima che una modifica dello stato di autenticazione imposti un nuovo utente.
Firma:
beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| callback | (user: User | null) => void | Promise<void> | il callback viene attivato prima che venga impostato il nuovo valore utente. Se viene visualizzato questo messaggio, l'utente non può essere configurato. |
| onAbort | () => void | viene attivato se viene generato un callback beforeAuthStateChanged() successivo, permettendoti di annullare eventuali effetti collaterali. |
Resi:
Auth.onAuthStateChanged()
Aggiunge un osservatore per le modifiche allo stato di accesso dell'utente.
Per mantenere il comportamento precedente, vedi Auth.onIdTokenChanged().
Firma:
onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| nextOrObserver | NextOrObserver<User | null> | il callback viene attivato al cambiamento. |
| errore | ErrorFn | Deprecato. Questo callback non viene mai attivato. Gli errori di accesso/uscita possono essere rilevati nelle promesse restituite dalle funzioni di accesso/uscita. |
| completati | CompleteFn | Deprecato. Questo callback non viene mai attivato. |
Resi:
Auth.onIdTokenChanged()
Aggiunge un osservatore per le modifiche al token ID dell'utente che ha eseguito l'accesso.
Sono inclusi gli eventi di accesso, uscita e aggiornamento dei token.
Firma:
onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| nextOrObserver | NextOrObserver<User | null> | il callback viene attivato al cambiamento. |
| errore | ErrorFn | Deprecato. Questo callback non viene mai attivato. Gli errori di accesso/uscita possono essere rilevati nelle promesse restituite dalle funzioni di accesso/uscita. |
| completati | CompleteFn | Deprecato. Questo callback non viene mai attivato. |
Resi:
Auth.setPersistence()
Modifica il tipo di persistenza nell'istanza Auth.
Questa operazione influirà sulla sessione di autenticazione attualmente salvata e applicherà questo tipo di persistenza per le richieste di accesso future, incluso l'accesso con le richieste di reindirizzamento.
In questo modo, per l'utente che esegue l'accesso è più semplice specificare se la sessione deve essere memorizzata o meno. Inoltre, semplifica il ripristino dello stato di autorizzazione per le applicazioni condivise da altri utenti o che contengono dati sensibili.
Questo metodo non funziona in un ambiente Node.js.
Firma:
setPersistence(persistence: Persistence): Promise<void>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| persistenza | Persistenza | La persistenza da utilizzare. |
Resi:
Promise<void>
Esempio
auth.setPersistence(browserSessionPersistence);
Auth.signOut()
Disconnette l'utente corrente. Questa operazione non revoca automaticamente il token ID dell'utente.
Questo metodo non è supportato dalle istanze Auth create con FirebaseServerApp.
Firma:
signOut(): Promise<void>;
Resi:
Promise<void>
Auth.updateCurrentUser()
Imposta in modo asincrono l'utente fornito come Auth.currentUser nell'istanza Auth.
Verrà creata una nuova copia dell'istanza dell'utente fornita e impostata come currentUser.
In questo modo verranno attivati i listener Auth.onAuthStateChanged() e Auth.onIdTokenChanged() come altri metodi di accesso.
L'operazione non riesce e viene restituito un errore se l'utente da aggiornare appartiene a un altro progetto Firebase.
Firma:
updateCurrentUser(user: User | null): Promise<void>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| utente | Utente | null | Il nuovo Utente. |
Resi:
Promise<void>
Auth.useDeviceLanguage()
Imposta la lingua corrente sulla preferenza predefinita del dispositivo/browser.
Firma:
useDeviceLanguage(): void;
Resi:
void