Auth interface

Interface représentant le service d'authentification Firebase.

Consultez Firebase Authentication pour un guide complet sur l'utilisation du service Firebase Auth.

Signature :

export interface Auth 

Propriétés

Propriété	Type	Description
app	FirebaseApp	Application FirebaseApp associée à l'instance de service Auth.
config	Configuration	Config utilisé pour initialiser cette instance.
currentUser	Utilisateur | null	Utilisateur actuellement connecté (ou valeur nulle).
emulatorConfig	EmulatorConfig | null	Configuration actuelle de l'émulateur (ou valeur nulle).
languageCode	chaîne | null	Code de langue de l'instance Auth.
name	chaîne	Nom de l'application associée à l'instance de service Auth.
paramètres	AuthSettings	Paramètres de l'instance Auth
tenantId	chaîne | null	ID du locataire de l'instance Auth.

Méthodes

Method	Description
authStateReady()	renvoie une promesse qui se résout immédiatement lorsque l'état d'authentification initial est réglé. Lorsque la promesse est résolue, l'utilisateur actuel peut être un utilisateur valide ou null s'il s'est déconnecté.
beforeAuthStateChanged(callback, onAbort)	Ajoute un rappel bloquant qui s'exécute avant qu'un changement d'état d'authentification ne définisse un nouvel utilisateur.
onAuthStateChanged(nextOrObserver, error, completed)	Ajoute un observateur des modifications apportées à l'état de connexion de l'utilisateur.
onIdTokenChanged(nextOrObserver, error, completed)	Ajoute un observateur des modifications apportées au jeton d'ID de l'utilisateur connecté.
setPersistence(persistence)	Modifie le type de persistance sur l'instance Auth.
signOut()	Déconnexion de l'utilisateur actuel. Cette action ne révoque pas automatiquement le jeton d'ID de l'utilisateur.
updateCurrentUser(user)	Définit de manière asynchrone l'utilisateur fourni en tant que Auth.currentUser sur l'instance Auth.
useDeviceLanguage()	Définit la langue actuelle sur les préférences par défaut du navigateur ou de l'appareil.

Auth.app

Application FirebaseApp associée à l'instance de service Auth.

Signature :

readonly app: FirebaseApp;

Auth.config

Config utilisé pour initialiser cette instance.

Signature :

readonly config: Config;

Auth.currentUser

Utilisateur actuellement connecté (ou valeur nulle).

Signature :

readonly currentUser: User | null;

Auth.emulatorConfig

Configuration actuelle de l'émulateur (ou valeur nulle).

Signature :

readonly emulatorConfig: EmulatorConfig | null;

Auth.languageCode

Code de langue de l'instance Auth.

Il s'agit d'une propriété en lecture/écriture. Lorsqu'il est défini sur "null", le paramètre de langue par défaut de la console Firebase est appliqué. Le code de langue sera propagé aux modèles d'action d'e-mail (réinitialisation du mot de passe, validation de l'adresse e-mail et révocation du changement d'adresse e-mail), aux modèles de SMS pour l'authentification du téléphone, à l'outil de vérification reCAPTCHA et aux opérations de redirection/pop-up OAuth, à condition que les fournisseurs spécifiés prennent en charge la localisation avec le code de langue spécifié.

Signature :

languageCode: string | null;

Auth.name

Nom de l'application associée à l'instance de service Auth.

Signature :

readonly name: string;

Auth.settings

Paramètres de l'instance Auth

Permet de modifier/lire les options liées à la configuration, comme le mode de validation de l'application pour l'authentification par téléphone.

Signature :

readonly settings: AuthSettings;

Auth.tenantId

ID du locataire de l'instance Auth.

Il s'agit d'une propriété en lecture/écriture. Lorsque vous définissez l'ID de locataire d'une instance Auth, toutes les futures opérations de connexion/inscription transmettent cet ID de locataire, et permettent de connecter ou d'inscrire les utilisateurs au projet locataire spécifié. Si elle est définie sur "null", les utilisateurs sont connectés au projet parent.

Signature :

tenantId: string | null;

Exemple

// 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()

renvoie une promesse qui se résout immédiatement lorsque l'état d'authentification initial est réglé. Lorsque la promesse est résolue, l'utilisateur actuel peut être un utilisateur valide ou null s'il s'est déconnecté.

Signature :

authStateReady(): Promise<void>;

Renvoie :

Promise<void>

Auth.beforeAuthStateChanged()

Ajoute un rappel bloquant qui s'exécute avant qu'un changement d'état d'authentification ne définisse un nouvel utilisateur.

Signature :

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

Paramètres

Paramètres	Type	Description
rappel	(user: User | null) => void | Promise<void>	rappel déclenché avant la définition d'une nouvelle valeur utilisateur. Si cette erreur est générée, l'utilisateur ne peut pas être défini.
onAbort	() => vide	rappel déclenché si un rappel beforeAuthStateChanged() ultérieur est généré, ce qui vous permet d'annuler tous les effets secondaires.

Renvoie :

Se désabonner

Auth.onAuthStateChanged()

Ajoute un observateur des modifications apportées à l'état de connexion de l'utilisateur.

Pour conserver l'ancien comportement, consultez Auth.onIdTokenChanged().

Signature :

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

Paramètres

Paramètres	Type	Description
nextOrObserver	NextOrObserver<User | null>	rappel déclenché lors d'une modification.
error	ErrorFn	Obsolète. Ce rappel n'est jamais déclenché. Les erreurs lors de la connexion/déconnexion peuvent être détectées dans les promesses renvoyées par les fonctions de connexion/déconnexion.
terminées	CompleteFn	Obsolète. Ce rappel n'est jamais déclenché.

Renvoie :

Se désabonner

Auth.onIdTokenChanged()

Ajoute un observateur des modifications apportées au jeton d'ID de l'utilisateur connecté.

Cela inclut les événements de connexion, de déconnexion et d'actualisation de jetons.

Signature :

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

Paramètres

Paramètres	Type	Description
nextOrObserver	NextOrObserver<User | null>	rappel déclenché lors d'une modification.
error	ErrorFn	Obsolète. Ce rappel n'est jamais déclenché. Les erreurs lors de la connexion/déconnexion peuvent être détectées dans les promesses renvoyées par les fonctions de connexion/déconnexion.
terminées	CompleteFn	Obsolète. Ce rappel n'est jamais déclenché.

Renvoie :

Se désabonner

Auth.setPersistence()

Modifie le type de persistance sur l'instance Auth.

Cela affectera la session d'authentification actuellement enregistrée et appliquera ce type de persistance pour les futures requêtes de connexion, y compris pour les requêtes de connexion avec des requêtes de redirection.

Cela permet à un utilisateur de se connecter facilement pour indiquer si sa session doit être mémorisée ou non. Il est également plus facile de ne jamais conserver l'état d'authentification pour les applications partagées par d'autres utilisateurs ou contenant des données sensibles.

Cette méthode ne fonctionne pas dans un environnement Node.js.

Signature :

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

Paramètres

Paramètres	Type	Description
persistance	Persistance	Valeur Persistance à utiliser.

Renvoie :

Promise<void>

Exemple

auth.setPersistence(browserSessionPersistence);

Auth.signOut()

Déconnexion de l'utilisateur actuel. Cette action ne révoque pas automatiquement le jeton d'ID de l'utilisateur.

Cette méthode n'est pas compatible avec les instances Auth créées avec FirebaseServerApp.

Signature :

signOut(): Promise<void>;

Renvoie :

Promise<void>

Auth.updateCurrentUser()

Définit de manière asynchrone l'utilisateur fourni en tant que Auth.currentUser sur l'instance Auth.

Une nouvelle copie de l'instance de l'utilisateur fourni sera créée et définie sur currentUser.

Cela déclenchera les écouteurs Auth.onAuthStateChanged() et Auth.onIdTokenChanged() comme les autres méthodes de connexion.

L'opération échoue et une erreur s'affiche si l'utilisateur à mettre à jour appartient à un autre projet Firebase.

Signature :

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

Paramètres

Paramètres	Type	Description
utilisateur	Utilisateur | null	Nouvel utilisateur.

Renvoie :

Promise<void>

Auth.useDeviceLanguage()

Définit la langue actuelle sur les préférences par défaut du navigateur ou de l'appareil.

Signature :

useDeviceLanguage(): void;

Renvoie :

void