Konto użytkownika.
Podpis:
export interface User extends UserInfo
Rozszerza się: UserInfo
Właściwości
| Właściwość | Typ | Opis |
|---|---|---|
| emailVerified | boolean | Określa, czy adres e-mail został zweryfikowany za pomocą funkcji sendEmailVerification() i applyActionCode(). |
| isAnonymous | boolean | Określa, czy użytkownik jest uwierzytelniany przy użyciu dostawcy ProviderId.ANONYMOUS. |
| metadane | UserMetadata | Dodatkowe metadane dotyczące czasu utworzenia i logowania użytkowników. |
| providerData | UserInfo[] | Dodatkowo dla każdego dostawcy, np. displayName i informacje o profilu. |
| refreshToken | string, | Token odświeżania używany do ponownego uwierzytelnienia użytkownika. Unikaj używania go bezpośrednio. Zamiast niego używaj metody User.getIdToken(), która odświeża token identyfikatora. |
| tenantId | string | null | Identyfikator najemcy użytkownika. |
Metody
| Metoda | Opis |
|---|---|
| delete() | usuwa użytkownika i wylogowuje go; |
| getIdToken(forceRefresh) | Zwraca token sieciowy JSON (JWT) służący do identyfikacji użytkownika w usłudze Firebase. |
| getIdTokenResult(forceRefresh) | Zwraca zdeserializowany token sieciowy JSON (JWT) służący do identyfikacji użytkownika w usłudze Firebase. |
| reload() | Odświeża dane użytkownika, jeśli jest zalogowany. |
| toJSON() | Zwraca serializowaną w formacie JSON reprezentację tego obiektu. |
User.emailVerified
Określa, czy adres e-mail został zweryfikowany za pomocą funkcji sendEmailVerification() i applyActionCode().
Podpis:
readonly emailVerified: boolean;
User.isAnonymous
Określa, czy użytkownik jest uwierzytelniany przy użyciu dostawcy ProviderId.ANONYMOUS.
Podpis:
readonly isAnonymous: boolean;
User.metadata
Dodatkowe metadane dotyczące czasu utworzenia i logowania użytkowników.
Podpis:
readonly metadata: UserMetadata;
User.providerData
Dodatkowo dla każdego dostawcy, np. displayName i informacje o profilu.
Podpis:
readonly providerData: UserInfo[];
User.refreshToken
Token odświeżania używany do ponownego uwierzytelnienia użytkownika. Unikaj używania go bezpośrednio. Zamiast niego używaj metody User.getIdToken(), która odświeża token identyfikatora.
Podpis:
readonly refreshToken: string;
User.tenantId
Identyfikator najemcy użytkownika.
Jest to właściwość tylko do odczytu, która wskazuje identyfikator najemcy użyty do zalogowania użytkownika. Jeśli użytkownik jest zalogowany z projektu nadrzędnego, ta wartość ma wartość null.
Podpis:
readonly tenantId: string | null;
Przykład
// 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()
usuwa użytkownika i wylogowuje go;
Ta metoda nie jest obsługiwana w przypadku żadnego użytkownika zalogowanego za pomocą instancji Auth utworzonych przy użyciu FirebaseServerApp.
Podpis:
delete(): Promise<void>;
Zwroty:
Promise<void>
User.getIdToken()
Zwraca token sieciowy JSON (JWT) służący do identyfikacji użytkownika w usłudze Firebase.
Zwraca bieżący token, jeśli nie wygasł lub nie wygaśnie w ciągu najbliższych 5 minut. W przeciwnym razie token zostanie odświeżony i pojawi się nowy.
Podpis:
getIdToken(forceRefresh?: boolean): Promise<string>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| forceRefresh | boolean | Wymuś odświeżenie niezależnie od wygaśnięcia tokena. |
Zwroty:
Obietnica<string>
User.getIdTokenResult()
Zwraca zdeserializowany token sieciowy JSON (JWT) służący do identyfikacji użytkownika w usłudze Firebase.
Zwraca bieżący token, jeśli nie wygasł lub nie wygaśnie w ciągu najbliższych 5 minut. W przeciwnym razie token zostanie odświeżony i pojawi się nowy.
Podpis:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| forceRefresh | boolean | Wymuś odświeżenie niezależnie od wygaśnięcia tokena. |
Zwroty:
Promise<IdTokenResult>
User.reload()
Odświeża dane użytkownika, jeśli jest zalogowany.
Podpis:
reload(): Promise<void>;
Zwroty:
Promise<void>
User.toJSON()
Zwraca serializowaną w formacie JSON reprezentację tego obiektu.
Podpis:
toJSON(): object;
Zwroty:
obiekt
Reprezentacja tego obiektu możliwa do sserializowania w formacie JSON.