UserRecord class

Bir kullanıcıyı temsil eder.

İmza:

export declare class UserRecord

Özellikler

Özellik Değiştiriciler Tür Açıklama
customClaims { [anahtar: dize]: herhangi bir; } Varsa kullanıcının özel hak talepleri nesnesi. Genellikle kullanıcı rollerini tanımlamak için kullanılır ve kimliği doğrulanmış kullanıcının kimlik jetonuna yayılır. BaseAuth.setCustomUserClaims() aracılığıyla ayarlanır.
devre dışı boolean Kullanıcının devre dışı olup olmadığı: Devre dışı için true; Etkin olanlar için false.
görünenAd dize Kullanıcının görünen adı.
email dize Ayarlanmışsa, kullanıcının birincil e-postası.
e-posta Doğrulaması boolean Kullanıcının birincil e-posta adresinin doğrulanıp doğrulanmadığı.
meta veriler KullanıcıMeta Verileri Kullanıcı hakkında ek meta veriler.
çok öğeli MultiFaktörAyarları Geçerli kullanıcı için çok öğeliyle ilgili özellikler (varsa).
şifreKarma dize Kullanıcının karma oluşturma işlemi uygulanmış şifresi (base64 kodlu), yalnızca Firebase Auth karma oluşturma algoritması (SCRYPT) kullanılıyorsa. Bu kullanıcı yüklenirken farklı bir karma oluşturma algoritması kullanılmışsa, başka bir Auth sisteminden taşıma sırasında olduğu gibi, bu boş bir dize olacaktır. Şifre ayarlanmazsa bu değer null olur. Bu özellik yalnızca kullanıcı, BaseAuth.listUsers() işlevinden elde edildiğinde kullanılabilir.
şifreSalt dize Yalnızca Firebase Auth karma oluşturma algoritması (SCRYPT) kullanılıyorsa kullanıcının şifresinin takviye değeri (base64 kodlu). Bu kullanıcıyı yüklemek için farklı bir karma oluşturma algoritması kullanılmışsa (normalde başka bir Auth sisteminden taşıma sırasında) bu boş bir dize olacaktır. Şifre ayarlanmazsa bu değer null olur. Bu özellik yalnızca kullanıcı, BaseAuth.listUsers() işlevinden elde edildiğinde kullanılabilir.
telefonNumarası dize Varsa kullanıcının birincil telefon numarası.
fotoURL dize Kullanıcının fotoğraf URL'si.
sağlayıcıVerisi Kullanıcı Bilgileri[] Kullanıcıya bağlı bir dizi sağlayıcı (ör. Google, Facebook).
kiracıNo dize | boş Varsa kullanıcının ait olduğu kiracının kimliği.
jetonlarValidAfterTime dize Kullanıcının jetonlarının geçerli olduğu tarihtir. UTC dizesi olarak biçimlendirilir. Bu, kullanıcının yenileme jetonu BaseAuth.revokeRefreshTokens() API'sinden veya büyük hesap değişikliklerinde (şifre sıfırlama, şifre veya e-posta güncellemeleri vb.) Firebase Auth arka ucundan her iptal edildiğinde güncellenir.
uid dize Kullanıcının uid cihazı.

Yöntemler

Yöntem Değiştiriciler Açıklama
toJSON() Bu nesnenin JSON'de seri hale getirilebilir bir temsilini döndürür.

UserRecord.customClaims

Varsa kullanıcının özel hak talepleri nesnesi. Genellikle kullanıcı rollerini tanımlamak için kullanılır ve kimliği doğrulanmış kullanıcının kimlik jetonuna yayılır. BaseAuth.setCustomUserClaims() aracılığıyla ayarlanır.

İmza:

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

Kullanıcı Kaydı.devre dışı

Kullanıcının devre dışı olup olmadığı: Devre dışı için true; Etkin olanlar için false.

İmza:

readonly disabled: boolean;

UserRecord.displayName

Kullanıcının görünen adı.

İmza:

readonly displayName?: string;

UserRecord.e-postasi

Varsa kullanıcının birincil e-postası.

İmza:

readonly email?: string;

UserRecord.emailDoğrulandı

Kullanıcının birincil e-posta adresinin doğrulanıp doğrulanmadığı.

İmza:

readonly emailVerified: boolean;

UserRecord.metadata

Kullanıcı hakkında ek meta veriler.

İmza:

readonly metadata: UserMetadata;

UserRecord.multiFactor

Geçerli kullanıcı için çok öğeliyle ilgili özellikler (varsa).

İmza:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

Kullanıcının karma oluşturma işlemi uygulanmış şifresi (base64 kodlu), yalnızca Firebase Auth karma oluşturma algoritması (SCRYPT) kullanılıyorsa. Bu kullanıcı yüklenirken farklı bir karma oluşturma algoritması kullanılmışsa (başka bir Auth sisteminden taşıma sırasında olduğu gibi) bu boş bir dize olacaktır. Şifre ayarlanmazsa bu değer null olur. Bu özellik yalnızca kullanıcı, BaseAuth.listUsers() işlevinden elde edildiğinde kullanılabilir.

İmza:

readonly passwordHash?: string;

UserRecord.passwordSalt

Yalnızca Firebase Auth karma oluşturma algoritması (SCRYPT) kullanılıyorsa kullanıcının şifresinin takviye değeri (base64 kodlu). Bu kullanıcıyı yüklemek için farklı bir karma oluşturma algoritması kullanılmışsa (normalde başka bir Auth sisteminden taşıma işlemi sırasında) bu boş bir dize olacaktır. Şifre ayarlanmazsa bu değer null olur. Bu özellik yalnızca kullanıcı, BaseAuth.listUsers() işlevinden elde edildiğinde kullanılabilir.

İmza:

readonly passwordSalt?: string;

KullanıcıKayıt.telefonNumarası

Varsa kullanıcının birincil telefon numarası.

İmza:

readonly phoneNumber?: string;

KullanıcıKaydı.fotoğrafURL'si

Kullanıcının fotoğraf URL'si.

İmza:

readonly photoURL?: string;

Kullanıcı Kaydı.SağlayıcıVerisi

Kullanıcıya bağlı bir dizi sağlayıcı (ör. Google, Facebook).

İmza:

readonly providerData: UserInfo[];

Kullanıcı Kaydı.kiracı Kimliği

Varsa kullanıcının ait olduğu kiracının kimliği.

İmza:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

Kullanıcının jetonlarının geçerli olduğu tarihtir. UTC dizesi olarak biçimlendirilir. Bu, kullanıcının yenileme jetonu BaseAuth.revokeRefreshTokens() API'sinden veya büyük hesap değişikliklerinde (şifre sıfırlama, şifre veya e-posta güncellemeleri vb.) Firebase Auth arka ucundan her iptal edildiğinde güncellenir.

İmza:

readonly tokensValidAfterTime?: string;

UserRecord.uid

Kullanıcının uid.

İmza:

readonly uid: string;

UserRecord.toJSON()

Bu nesnenin JSON'de seri hale getirilebilir bir temsilini döndürür.

İmza:

toJSON(): object;

Şunu döndürür:

nesne

Bu nesnenin JSON'de seri hale getirilebilir bir temsili.