Ein Nutzerkonto.
Unterschrift:
export interface User extends UserInfo
Erweitert: UserInfo
Attribute
| Property | Typ | Beschreibung |
|---|---|---|
| emailVerified | boolean | Gibt an, ob die E-Mail-Adresse mit sendEmailVerification() und applyActionCode() bestätigt wurde. |
| isAnonymous | boolean | Gibt an, ob der Nutzer mit dem Anbieter ProviderId.ANONYMOUS authentifiziert wird. |
| metadata | UserMetadata | Zusätzliche Metadaten zu Nutzererstellungs- und Anmeldezeiten. |
| providerData | UserInfo[] | Zusätzliche pro Anbieter, z. B. displayName und Profilinformationen. |
| refreshToken | String | Aktualisierungstoken zur erneuten Authentifizierung des Nutzers. Vermeiden Sie die direkte Verwendung und ziehen Sie stattdessen User.getIdToken() vor, um das ID-Token zu aktualisieren. |
| tenantId | String | null | Die Mandanten-ID des Nutzers. |
Methoden
| Method | Beschreibung |
|---|---|
| delete() | Der Nutzer wird gelöscht und abgemeldet. |
| getIdToken(forceRefresh) | Gibt ein JSON Web Token (JWT) zurück, mit dem der Nutzer in einem Firebase-Dienst identifiziert wird. |
| getIdTokenResult(forceRefresh) | Gibt ein deserialisiertes JSON Web Token (JWT) zurück, mit dem der Nutzer in einem Firebase-Dienst identifiziert wird. |
| reload() | Der Nutzer wird aktualisiert, wenn er angemeldet ist. |
| toJSON() | Gibt eine JSON-serialisierbare Darstellung dieses Objekts zurück. |
User.emailVerified
Gibt an, ob die E-Mail-Adresse mit sendEmailVerification() und applyActionCode() bestätigt wurde.
Unterschrift:
readonly emailVerified: boolean;
User.isAnonymous
Gibt an, ob der Nutzer mit dem Anbieter ProviderId.ANONYMOUS authentifiziert wird.
Unterschrift:
readonly isAnonymous: boolean;
User.metadata
Zusätzliche Metadaten zu Nutzererstellungs- und Anmeldezeiten.
Unterschrift:
readonly metadata: UserMetadata;
User.providerData
Zusätzliche pro Anbieter, z. B. displayName und Profilinformationen.
Unterschrift:
readonly providerData: UserInfo[];
User.refreshToken
Aktualisierungstoken zur erneuten Authentifizierung des Nutzers. Vermeiden Sie die direkte Verwendung und ziehen Sie stattdessen User.getIdToken() vor, um das ID-Token zu aktualisieren.
Unterschrift:
readonly refreshToken: string;
User.tenantId
Die Mandanten-ID des Nutzers.
Dies ist eine schreibgeschützte Property, die die Mandanten-ID angibt, mit der der Nutzer angemeldet wird. Der Wert ist null, wenn der Nutzer im übergeordneten Projekt angemeldet ist.
Unterschrift:
readonly tenantId: string | null;
Beispiel
// 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()
Der Nutzer wird gelöscht und abgemeldet.
Diese Methode wird bei keinem User unterstützt, der über Auth-Instanzen angemeldet ist, die mit einer FirebaseServerApp erstellt wurden.
Unterschrift:
delete(): Promise<void>;
Gibt zurück:
Promise<void>
User.getIdToken()
Gibt ein JSON Web Token (JWT) zurück, mit dem der Nutzer in einem Firebase-Dienst identifiziert wird.
Gibt das aktuelle Token zurück, wenn es nicht abgelaufen ist oder nicht innerhalb der nächsten fünf Minuten abläuft. Andernfalls wird das Token aktualisiert und ein neues zurückgegeben.
Unterschrift:
getIdToken(forceRefresh?: boolean): Promise<string>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| forceRefresh | boolean | Erzwingt die Aktualisierung unabhängig vom Ablauf des Tokens. |
Gibt zurück:
Versprechen<string>
User.getIdTokenResult()
Gibt ein deserialisiertes JSON Web Token (JWT) zurück, mit dem der Nutzer in einem Firebase-Dienst identifiziert wird.
Gibt das aktuelle Token zurück, wenn es nicht abgelaufen ist oder nicht innerhalb der nächsten fünf Minuten abläuft. Andernfalls wird das Token aktualisiert und ein neues zurückgegeben.
Unterschrift:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| forceRefresh | boolean | Erzwingt die Aktualisierung unabhängig vom Ablauf des Tokens. |
Gibt zurück:
Promise<IdTokenResult>
User.reload()
Der Nutzer wird aktualisiert, wenn er angemeldet ist.
Unterschrift:
reload(): Promise<void>;
Gibt zurück:
Promise<void>
User.toJSON()
Gibt eine JSON-serialisierbare Darstellung dieses Objekts zurück.
Unterschrift:
toJSON(): object;
Gibt zurück:
Objekt
Eine JSON-serialisierbare Darstellung dieses Objekts.