Konto użytkownika.
Podpis:
export interface User extends UserInfo
Rozszerza: UserInfo
Właściwości
| Właściwość | Typ | Opis |
|---|---|---|
| Zweryfikowany e-mail | wartość logiczna | Określa, czy adres e-mail został zweryfikowany przy użyciu sendEmailverification() i applyActionCode(). |
| jest anonimowy, | wartość logiczna | Określa, czy użytkownik jest uwierzytelniany przy użyciu dostawcy ProviderId.ANONYMOUS. |
| metadane, | UserMetadata | Dodatkowe metadane dotyczące czasu utworzenia konta użytkownika i logowania. |
| providerData | Informacje o użytkowniku[] | Dodatkowe dla każdego dostawcy, takie jak nazwa displayowa i informacje w profilu. |
| refreshToken. | ciąg znaków | Token odświeżania używany do ponownego uwierzytelniania użytkownika. Unikaj bezpośredniego używania tego parametru i preferuj opcję User.getIdToken() do odświeżania tokena identyfikatora. |
| tenantId, | ciąg znaków | wartość null | Identyfikator najemcy użytkownika. |
Metody
| Metoda | Opis |
|---|---|
| delete() | Usuwa użytkownika i wylogowuje go. |
| getIdToken(forceRefresh) | Zwraca token internetowy JSON (JWT) używany do identyfikowania użytkownika w usłudze Firebase. |
| getIdTokenResult(forceRefresh) | Zwraca zdeserializowany token sieciowy JSON (JWT) używany do identyfikacji użytkownika w usłudze Firebase. |
| reload() | Jeśli użytkownik jest zalogowany, odświeża dane użytkownika. |
| toJSON(), | Zwraca możliwą do serializowania reprezentację tego obiektu w formacie JSON. |
Użytkownik.adresemailZweryfikowany
Określa, czy adres e-mail został zweryfikowany przy użyciu sendEmailverification() i applyActionCode().
Podpis:
readonly emailVerified: boolean;
Użytkownik.jestanonimowy
Określa, czy użytkownik jest uwierzytelniany przy użyciu dostawcy ProviderId.ANONYMOUS.
Podpis:
readonly isAnonymous: boolean;
Metadane użytkownika
Dodatkowe metadane dotyczące czasu utworzenia konta użytkownika i logowania.
Podpis:
readonly metadata: UserMetadata;
Dane dostawcy
Dodatkowe dla każdego dostawcy, takie jak nazwa displayowa i informacje w profilu.
Podpis:
readonly providerData: UserInfo[];
User.refreshToken
Token odświeżania używany do ponownego uwierzytelniania użytkownika. Unikaj bezpośredniego używania tego parametru i preferuj opcję User.getIdToken() do odświeżania tokena identyfikatora.
Podpis:
readonly refreshToken: string;
Identyfikator użytkownika najemcy
Identyfikator najemcy użytkownika.
Jest to usługa tylko do odczytu, która wskazuje identyfikator najemcy użyty do zalogowania się użytkownika. Jeśli użytkownik jest zalogowany z projektu nadrzędnego, 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 instancji User zalogowanych przez instancje Auth utworzone za pomocą FirebaseServerApp.
Podpis:
delete(): Promise<void>;
Zwroty:
Obietnica<void>
User.getIdToken()
Zwraca token internetowy JSON (JWT) używany do identyfikowania użytkownika w usłudze Firebase.
Zwraca bieżący token, jeśli jeszcze nie wygasł lub nie wygaśnie w ciągu najbliższych 5 minut. W przeciwnym razie spowoduje to odświeżenie tokena i zwrócenie nowego.
Podpis:
getIdToken(forceRefresh?: boolean): Promise<string>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| wymuszanie odświeżania | wartość logiczna | Wymuszaj odświeżanie niezależnie od daty wygaśnięcia tokena. |
Zwroty:
Obietnica<ciąg>
User.getIdTokenResult()
Zwraca zdeserializowany token sieciowy JSON (JWT) używany do identyfikacji użytkownika w usłudze Firebase.
Zwraca bieżący token, jeśli jeszcze nie wygasł lub nie wygaśnie w ciągu najbliższych 5 minut. W przeciwnym razie spowoduje to odświeżenie tokena i zwrócenie nowego.
Podpis:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| wymuszanie odświeżania | wartość logiczna | Wymuszaj odświeżanie niezależnie od daty wygaśnięcia tokena. |
Zwroty:
Obietnica<IdTokenResult>
User.reload()
Jeśli użytkownik jest zalogowany, odświeża dane użytkownika.
Podpis:
reload(): Promise<void>;
Zwroty:
Obietnica<void>
User.toJSON()
Zwraca możliwą do serializowania reprezentację tego obiektu w formacie JSON.
Podpis:
toJSON(): object;
Zwroty:
Obiekt
Możliwa do serializowania reprezentacja tego obiektu w formacie JSON.