UserRecord class

Reprezentuje użytkownika.

Podpis:

export declare class UserRecord 

Nieruchomości

Nieruchomość Modyfikatory Typ Opis
niestandardowe roszczenia { [klucz: ciąg znaków]: dowolny; } Niestandardowy obiekt oświadczeń użytkownika, jeśli jest dostępny, zwykle używany do definiowania ról użytkowników i propagowany do tokenu identyfikatora uwierzytelnionego użytkownika. Ustawia się to za pomocą BaseAuth.setCustomUserClaims()
wyłączony wartość logiczna Niezależnie od tego, czy użytkownik jest wyłączony: true dla wyłączonego; false dla włączonego.
wyświetlana nazwa strunowy Wyświetlana nazwa użytkownika.
e-mail strunowy Główny adres e-mail użytkownika, jeśli jest ustawiony.
e-mail zweryfikowany wartość logiczna Określa, czy główny adres e-mail użytkownika został zweryfikowany.
metadane Metadane użytkownika Dodatkowe metadane o użytkowniku.
wieloczynnikowy Ustawienia wieloczynnikowe Właściwości powiązane z wieloma czynnikami dla bieżącego użytkownika, jeśli są dostępne.
Hasło Hasła strunowy Zaszyfrowane hasło użytkownika (zakodowane w formacie Base64), tylko jeśli używany jest algorytm mieszający Firebase Auth (SCRYPT). Jeśli podczas przesyłania tego użytkownika użyto innego algorytmu mieszania, co jest typowe podczas migracji z innego systemu uwierzytelniania, będzie to pusty ciąg znaków. Jeśli nie ustawiono żadnego hasła, wartość ta wynosi null. Jest to dostępne tylko wtedy, gdy użytkownik zostanie uzyskany z BaseAuth.listUsers() .
hasłoSól strunowy Sól hasła użytkownika (zakodowana w formacie Base64), tylko jeśli używany jest algorytm mieszający Firebase Auth (SCRYPT). Jeśli do przesłania tego użytkownika użyto innego algorytmu haszującego, co jest typowe podczas migracji z innego systemu uwierzytelniania, będzie to pusty ciąg znaków. Jeśli nie ustawiono żadnego hasła, wartość ta wynosi null. Jest to dostępne tylko wtedy, gdy użytkownik zostanie uzyskany z BaseAuth.listUsers() .
numer telefonu strunowy Główny numer telefonu użytkownika, jeśli jest ustawiony.
adres URL zdjęcia strunowy Adres URL zdjęcia użytkownika.
Dane dostawcy Informacje użytkownika [] Szereg dostawców (na przykład Google, Facebook) powiązanych z użytkownikiem.
identyfikator najemcy ciąg | zero Identyfikator dzierżawy, do którego należy użytkownik, jeśli jest dostępny.
tokenyValidAfterTime strunowy Data, po której tokeny użytkownika tracą ważność, sformatowana jako ciąg UTC. Jest to aktualizowane za każdym razem, gdy token odświeżania użytkownika zostanie unieważniony z interfejsu API BaseAuth.revokeRefreshTokens() lub z zaplecza Firebase Auth w przypadku dużych zmian na koncie (reset hasła, aktualizacja hasła lub adresu e-mail itp.).
uid strunowy uid użytkownika.

Metody

metoda Modyfikatory Opis
doJSON() Zwraca reprezentację tego obiektu nadającą się do serializacji w formacie JSON.

UserRecord.customClaims

Niestandardowy obiekt oświadczeń użytkownika, jeśli jest dostępny, zwykle używany do definiowania ról użytkowników i propagowany do tokenu identyfikatora uwierzytelnionego użytkownika. Ustawia się to za pomocą BaseAuth.setCustomUserClaims()

Podpis:

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

UserRecord.wyłączony

Niezależnie od tego, czy użytkownik jest wyłączony: true dla wyłączonego; false dla włączonego.

Podpis:

readonly disabled: boolean;

NazwaRekordu Użytkownika.wyświetlana

Wyświetlana nazwa użytkownika.

Podpis:

readonly displayName?: string;

Rekord użytkownika.e-mail

Główny adres e-mail użytkownika, jeśli jest ustawiony.

Podpis:

readonly email?: string;

UserRecord.emailZweryfikowano

Określa, czy główny adres e-mail użytkownika został zweryfikowany.

Podpis:

readonly emailVerified: boolean;

Metadane rekordu użytkownika

Dodatkowe metadane o użytkowniku.

Podpis:

readonly metadata: UserMetadata;

UserRecord.multiFactor

Właściwości powiązane z wieloma czynnikami dla bieżącego użytkownika, jeśli są dostępne.

Podpis:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

Zaszyfrowane hasło użytkownika (zakodowane w formacie Base64), tylko jeśli używany jest algorytm mieszający Firebase Auth (SCRYPT). Jeśli podczas przesyłania tego użytkownika użyto innego algorytmu mieszania, co jest typowe podczas migracji z innego systemu uwierzytelniania, będzie to pusty ciąg znaków. Jeśli nie ustawiono żadnego hasła, wartość ta wynosi null. Jest to dostępne tylko wtedy, gdy użytkownik zostanie uzyskany z BaseAuth.listUsers() .

Podpis:

readonly passwordHash?: string;

UserRecord.hasłoSól

Sól hasła użytkownika (zakodowana w formacie Base64), tylko jeśli używany jest algorytm mieszający Firebase Auth (SCRYPT). Jeśli do przesłania tego użytkownika użyto innego algorytmu haszującego, co jest typowe podczas migracji z innego systemu uwierzytelniania, będzie to pusty ciąg znaków. Jeśli nie ustawiono żadnego hasła, wartość ta wynosi null. Jest to dostępne tylko wtedy, gdy użytkownik zostanie uzyskany z BaseAuth.listUsers() .

Podpis:

readonly passwordSalt?: string;

Numer rekordu użytkownika.telefonu

Główny numer telefonu użytkownika, jeśli jest ustawiony.

Podpis:

readonly phoneNumber?: string;

UserRecord.photoURL

Adres URL zdjęcia użytkownika.

Podpis:

readonly photoURL?: string;

Dane użytkownikaRecord.providerData

Szereg dostawców (na przykład Google, Facebook) powiązanych z użytkownikiem.

Podpis:

readonly providerData: UserInfo[];

UserRecord.tenantId

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

Podpis:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

Data, po której tokeny użytkownika tracą ważność, sformatowana jako ciąg UTC. Jest to aktualizowane za każdym razem, gdy token odświeżania użytkownika zostanie unieważniony z interfejsu API BaseAuth.revokeRefreshTokens() lub z zaplecza Firebase Auth w przypadku dużych zmian na koncie (reset hasła, aktualizacja hasła lub adresu e-mail itp.).

Podpis:

readonly tokensValidAfterTime?: string;

UserRecord.uid

uid użytkownika .

Podpis:

readonly uid: string;

UserRecord.toJSON()

Zwraca reprezentację tego obiektu nadającą się do serializacji w formacie JSON.

Podpis:

toJSON(): object;

Zwroty:

obiekt

Reprezentacja tego obiektu możliwa do serializacji w formacie JSON.