Un compte utilisateur.
Signature :
export interface User extends UserInfo
Extension:UserInfo
Propriétés
| Propriété | Type | Description |
|---|---|---|
| emailVerified | boolean | Indique si l'adresse e-mail a été validée avec sendEmailVerification() et applyActionCode(). |
| isAnonymous | boolean | Indique si l'utilisateur est authentifié à l'aide du fournisseur ProviderId.ANONYMOUS. |
| metadata | UserMetadata | Métadonnées supplémentaires sur les heures de création et de connexion de l'utilisateur |
| providerData | UserInfo[] | Supplément par fournisseur, comme le nom à afficher et les informations de profil. |
| refreshToken | chaîne | Jeton d'actualisation utilisé pour réauthentifier l'utilisateur. Évitez de l'utiliser directement. User.getIdToken() doit plutôt actualiser le jeton d'ID. |
| tenantId | chaîne | null | ID du locataire de l'utilisateur. |
Méthodes
| Method | Description |
|---|---|
| Supprimer | Supprime l'utilisateur et le déconnecte. |
| getIdToken(forceRefresh) | Renvoie un jeton Web JSON (JWT, JSON Web Token) utilisé pour identifier l'utilisateur auprès d'un service Firebase. |
| getIdTokenResult(forceRefresh) | Renvoie un jeton Web JSON (JWT) désérialisé utilisé pour identifier l'utilisateur auprès d'un service Firebase. |
| Actualiser() | Actualise l'utilisateur s'il est connecté. |
| toJSON() | Renvoie une représentation sérialisable JSON de cet objet. |
User.emailVerified
Indique si l'adresse e-mail a été validée avec sendEmailVerification() et applyActionCode().
Signature :
readonly emailVerified: boolean;
User.isAnonymous
Indique si l'utilisateur est authentifié à l'aide du fournisseur ProviderId.ANONYMOUS.
Signature :
readonly isAnonymous: boolean;
User.metadata
Métadonnées supplémentaires sur les heures de création et de connexion de l'utilisateur
Signature :
readonly metadata: UserMetadata;
User.providerData
Supplément par fournisseur, comme le nom à afficher et les informations de profil.
Signature :
readonly providerData: UserInfo[];
User.refreshToken
Jeton d'actualisation utilisé pour réauthentifier l'utilisateur. Évitez de l'utiliser directement. User.getIdToken() doit plutôt actualiser le jeton d'ID.
Signature :
readonly refreshToken: string;
User.tenantId
ID du locataire de l'utilisateur.
Il s'agit d'une propriété en lecture seule qui indique l'ID de locataire utilisé pour connecter l'utilisateur. Cette valeur est nulle si l'utilisateur est connecté à partir du projet parent.
Signature :
readonly 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'.
User.delete()
Supprime l'utilisateur et le déconnecte.
Cette méthode n'est pas compatible avec les utilisateurs connectés par des instances Auth créées avec FirebaseServerApp.
Signature :
delete(): Promise<void>;
Renvoie :
Promise<void>
User.getIdToken()
Renvoie un jeton Web JSON (JWT, JSON Web Token) utilisé pour identifier l'utilisateur auprès d'un service Firebase.
Renvoie le jeton actuel s'il n'a pas expiré ou s'il n'arrive pas à expiration dans les cinq minutes suivantes. Sinon, le jeton sera actualisé et un nouveau sera renvoyé.
Signature :
getIdToken(forceRefresh?: boolean): Promise<string>;
Paramètres
| Paramètres | Type | Description |
|---|---|---|
| forceRefresh | boolean | Forcer l'actualisation quelle que soit l'expiration du jeton. |
Renvoie :
Promesse<chaîne>
User.getIdTokenResult()
Renvoie un jeton Web JSON (JWT) désérialisé utilisé pour identifier l'utilisateur auprès d'un service Firebase.
Renvoie le jeton actuel s'il n'a pas expiré ou s'il n'arrive pas à expiration dans les cinq minutes suivantes. Sinon, le jeton sera actualisé et un nouveau sera renvoyé.
Signature :
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Paramètres
| Paramètres | Type | Description |
|---|---|---|
| forceRefresh | boolean | Forcer l'actualisation quelle que soit l'expiration du jeton. |
Renvoie :
Promise<IdTokenResult>
User.reload()
Actualise l'utilisateur s'il est connecté.
Signature :
reload(): Promise<void>;
Renvoie :
Promise<void>
User.toJSON()
Renvoie une représentation sérialisable JSON de cet objet.
Signature :
toJSON(): object;
Renvoie :
objet
Représentation de cet objet sérialisable au format JSON.