UserRecord class

Reprezentuje użytkownika.

Podpis:

export declare class UserRecord

Właściwości

Właściwość Modyfikatory Typ Opis
customClaims – { [klucz: ciąg znaków]: any; Obiekt deklaracji niestandardowych użytkownika (jeśli jest dostępny) jest zwykle używany do definiowania ról użytkownika i przesyłany do tokena tożsamości uwierzytelnionego użytkownika. Tę wartość ustawia się przez BaseAuth.setCustomUserClaims().
wyłączony wartość logiczna Określa, czy użytkownik jest wyłączony: true – wyłączony; false dla włączonego.
nazwawyświetlana ciąg znaków Wyświetlana nazwa użytkownika.
e-mail ciąg znaków Podstawowy adres e-mail użytkownika, jeśli jest ustawiony.
Zweryfikowany e-mail wartość logiczna Wskazuje, czy podstawowy adres e-mail użytkownika został zweryfikowany.
metadane, UserMetadata Dodatkowe metadane dotyczące użytkownika.
multiFactor, Ustawienia MultiFactor Właściwości wielopoziomowe związane z bieżącym użytkownikiem (jeśli są dostępne).
passwordHash ciąg znaków Zaszyfrowane hasło użytkownika (zakodowane w formacie base64) tylko wtedy, gdy używany jest algorytm haszowania uwierzytelniania Firebase (SCRYPT). Jeśli podczas przesyłania tego użytkownika został użyty inny algorytm szyfrowania (co jest zwykle podczas migracji z innego systemu uwierzytelniania), będzie to pusty ciąg znaków. Jeśli nie ustawiono hasła, to pole ma wartość null. Ta opcja jest dostępna tylko wtedy, gdy użytkownik został pozyskany z BaseAuth.listUsers().
passwordSalt, ciąg znaków Sól do hasła użytkownika (zakodowana w formacie base64) tylko wtedy, gdy używany jest algorytm haszowania uwierzytelniania Firebase (SCRYPT). Jeśli do przesłania tego użytkownika został użyty inny algorytm szyfrowania (zazwyczaj w przypadku migracji z innego systemu uwierzytelniania), będzie to pusty ciąg znaków. Jeśli nie ustawiono hasła, to pole ma wartość null. Ta opcja jest dostępna tylko wtedy, gdy użytkownik został pozyskany z BaseAuth.listUsers().
numer telefonu ciąg znaków Podstawowy numer telefonu użytkownika, jeśli został ustawiony.
URL zdjęcia ciąg znaków Adres URL zdjęcia użytkownika.
providerData Informacje o użytkowniku[] Tablica dostawców (np. Google, Facebook) powiązanych z użytkownikiem.
tenantId, ciąg znaków | wartość null Identyfikator najemcy, do którego należy użytkownik, jeśli jest dostępny.
tokensValidAfterTime ciąg znaków Data, po której tokeny użytkownika są ważne, w postaci ciągu UTC. Ta wartość jest aktualizowana za każdym razem, gdy token odświeżania użytkownika zostanie unieważniony przez interfejs API BaseAuth.revokeRefreshTokens() lub z backendu uwierzytelniania Firebase w przypadku dużych zmian na koncie (zmiany hasła, zresetowania hasła, aktualizacji e-maili itp.).
UID ciąg znaków uid użytkownika.

Metody

Metoda Modyfikatory Opis
toJSON(), Zwraca możliwą do serializowania reprezentację tego obiektu w formacie JSON.

UserRecord.customClaims

Obiekt deklaracji niestandardowych użytkownika (jeśli jest dostępny) jest zwykle używany do definiowania ról użytkownika i przesyłany do tokena tożsamości uwierzytelnionego użytkownika. Tę wartość ustawia się przez BaseAuth.setCustomUserClaims().

Podpis:

readonly customClaims?: {
        [key: string]: any;
    };

Rekord UserRecord.Wyłączono

Określa, czy użytkownik jest wyłączony: true – wyłączony; false dla włączonego.

Podpis:

readonly disabled: boolean;

Rekord UserRecord.displayName

Wyświetlana nazwa użytkownika.

Podpis:

readonly displayName?: string;

Rekord użytkownika.email

Podstawowy adres e-mail użytkownika, jeśli jest ustawiony.

Podpis:

readonly email?: string;

Rekord UserRecord.emailZweryfikowany

Wskazuje, czy podstawowy adres e-mail użytkownika został zweryfikowany.

Podpis:

readonly emailVerified: boolean;

Rekord UserRecord.metadata

Dodatkowe metadane dotyczące użytkownika.

Podpis:

readonly metadata: UserMetadata;

UserRecord.multiFactor

Właściwości wielopoziomowe związane z bieżącym użytkownikiem (jeśli są dostępne).

Podpis:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

Zaszyfrowane hasło użytkownika (zakodowane w formacie base64) tylko wtedy, gdy używany jest algorytm haszowania uwierzytelniania Firebase (SCRYPT). Jeśli podczas przesyłania tego użytkownika został użyty inny algorytm szyfrowania (co jest zwykle podczas migracji z innego systemu uwierzytelniania), będzie to pusty ciąg znaków. Jeśli nie ustawiono hasła, to pole ma wartość null. Ta opcja jest dostępna tylko wtedy, gdy użytkownik został pozyskany z BaseAuth.listUsers().

Podpis:

readonly passwordHash?: string;

UserRecord.passwordSalt

Sól do hasła użytkownika (zakodowana w formacie base64) tylko wtedy, gdy używany jest algorytm haszowania uwierzytelniania Firebase (SCRYPT). Jeśli do przesłania tego użytkownika został użyty inny algorytm szyfrowania (zazwyczaj w przypadku migracji z innego systemu uwierzytelniania), będzie to pusty ciąg znaków. Jeśli nie ustawiono hasła, to pole ma wartość null. Ta opcja jest dostępna tylko wtedy, gdy użytkownik został pozyskany z BaseAuth.listUsers().

Podpis:

readonly passwordSalt?: string;

Rekord UserRecord.phoneNumber

Podstawowy numer telefonu użytkownika, jeśli został ustawiony.

Podpis:

readonly phoneNumber?: string;

UserRecord.photoURL (URL rekordu użytkownika)

Adres URL zdjęcia użytkownika.

Podpis:

readonly photoURL?: string;

Dane_rekordu_użytkownika.dostawcy

Tablica dostawców (np. Google, Facebook) powiązanych z użytkownikiem.

Podpis:

readonly providerData: UserInfo[];

Identyfikator_rekordu_użytkownika.identyfikator najemcy

Identyfikator najemcy, do którego należy użytkownik, jeśli jest dostępny.

Podpis:

readonly tenantId?: string | null;

Rekord UserRecord.tokensValidAfterTime

Data, po której tokeny użytkownika są ważne, w postaci ciągu UTC. Ta wartość jest aktualizowana za każdym razem, gdy token odświeżania użytkownika zostanie unieważniony przez interfejs API BaseAuth.revokeRefreshTokens() lub z backendu uwierzytelniania Firebase w przypadku dużych zmian na koncie (zmiany hasła, zresetowania hasła, aktualizacji e-maili itp.).

Podpis:

readonly tokensValidAfterTime?: string;

UserRecord.uid

uid użytkownika.

Podpis:

readonly uid: string;

UserRecord.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.