Bir kullanıcıyı temsil eder.
İmza:
export declare class UserRecord
Özellikler
Mülk | Değiştiriciler | Tip | Tanım |
---|---|---|---|
özel talepler | { [anahtar: string]: herhangi biri; } | Kullanıcının özel talep nesnesi (varsa), genellikle kullanıcı rollerini tanımlamak için kullanılır ve kimliği doğrulanmış bir kullanıcının kimlik belirtecine yayılır. Bu , BaseAuth.setCustomUserClaims() aracılığıyla ayarlanır. | |
engelli | boolean | Kullanıcının devre dışı olup olmadığı: devre dışı için true ; etkin için false . | |
ekran adı | sicim | Kullanıcının görünen adı. | |
e-posta | sicim | Ayarlanmışsa kullanıcının birincil e-posta adresi. | |
E-posta Doğrulandı | boolean | Kullanıcının birincil e-postasının doğrulanıp doğrulanmadığı. | |
meta veri | Kullanıcı Meta Verileri | Kullanıcı hakkında ek meta veriler. | |
çok faktörlü | Çok Faktörlü Ayarlar | Mevcut kullanıcı için çok faktörlü ilgili özellikler (varsa). | |
şifreHash | sicim | Kullanıcının karma şifresi (base64 kodlu), yalnızca Firebase Auth karma algoritması (SCRYPT) kullanılıyorsa. Bu kullanıcıyı yüklerken, başka bir Kimlik Doğrulama sisteminden taşıma sırasında tipik olduğu gibi, farklı bir karma algoritması kullanılmışsa, bu boş bir dize olacaktır. Herhangi bir parola ayarlanmadıysa bu boştur. Bu yalnızca kullanıcı BaseAuth.listUsers() adresinden edinildiğinde kullanılabilir. . | |
şifreTuz | sicim | Kullanıcının şifre tuzu (base64 kodlu), yalnızca Firebase Auth karma algoritması (SCRYPT) kullanılıyorsa. Bu kullanıcıyı yüklemek için farklı bir karma algoritması kullanılmışsa (genellikle başka bir Kimlik Doğrulama sisteminden taşıma sırasında), bu boş bir dize olacaktır. Herhangi bir parola ayarlanmadıysa bu boştur. Bu yalnızca kullanıcı BaseAuth.listUsers() adresinden edinildiğinde kullanılabilir. . | |
telefon numarası | sicim | Ayarlanmışsa kullanıcının birincil telefon numarası. | |
fotoğrafURL | sicim | Kullanıcının fotoğraf URL'si. | |
sağlayıcıVerileri | Kullanıcı bilgisi [] | Kullanıcıya bağlı bir dizi sağlayıcı (örneğin, Google, Facebook). | |
kiracı kimliği | dize | hükümsüz | Varsa, kullanıcının ait olduğu kiracının kimliği. | |
jetonlarValidAfterTime | sicim | Kullanıcının belirteçlerinin geçerli olacağı tarih, UTC dizesi olarak biçimlendirilmiştir. Bu, kullanıcının yenileme jetonunun BaseAuth.revokeRefreshTokens() API'sinden veya Firebase Auth arka ucundan büyük hesap değişikliklerinde (şifre sıfırlama, şifre veya e-posta güncellemeleri vb.) her iptal edilişinde güncellenir. | |
kullanıcı kimliği | sicim | Kullanıcının kullanıcı uid . |
Yöntemler
Yöntem | Değiştiriciler | Tanım |
---|---|---|
JSON()'a | Bu nesnenin JSON ile seri hale getirilebilir gösterimini döndürür. |
UserRecord.customClaims
Kullanıcının özel talep nesnesi (varsa), genellikle kullanıcı rollerini tanımlamak için kullanılır ve kimliği doğrulanmış bir kullanıcının kimlik belirtecine yayılır. Bu , 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 için false
.
İmza:
readonly disabled: boolean;
UserRecord.displayName
Kullanıcının görünen adı.
İmza:
readonly displayName?: string;
Kullanıcı Kaydı.e-postası
Ayarlanmışsa kullanıcının birincil e-posta adresi.
İmza:
readonly email?: string;
UserRecord.emailDoğrulandı
Kullanıcının birincil e-postasının doğrulanıp doğrulanmadığı.
İmza:
readonly emailVerified: boolean;
UserRecord.meta verileri
Kullanıcı hakkında ek meta veriler.
İmza:
readonly metadata: UserMetadata;
UserRecord.multiFactor
Mevcut kullanıcı için çok faktörlü ilgili özellikler (varsa).
İmza:
readonly multiFactor?: MultiFactorSettings;
UserRecord.passwordHash
Kullanıcının karma şifresi (base64 kodlu), yalnızca Firebase Auth karma algoritması (SCRYPT) kullanılıyorsa. Bu kullanıcıyı yüklerken, başka bir Kimlik Doğrulama sisteminden taşıma sırasında tipik olduğu gibi, farklı bir karma algoritması kullanılmışsa, bu boş bir dize olacaktır. Herhangi bir parola ayarlanmadıysa bu boştur. Bu yalnızca kullanıcı BaseAuth.listUsers() adresinden edinildiğinde kullanılabilir. .
İmza:
readonly passwordHash?: string;
UserRecord.passwordSalt
Kullanıcının şifre tuzu (base64 kodlu), yalnızca Firebase Auth karma algoritması (SCRYPT) kullanılıyorsa. Bu kullanıcıyı yüklemek için farklı bir karma algoritması kullanılmışsa (genellikle başka bir Kimlik Doğrulama sisteminden taşıma sırasında), bu boş bir dize olacaktır. Herhangi bir parola ayarlanmadıysa bu boştur. Bu yalnızca kullanıcı BaseAuth.listUsers() adresinden edinildiğinde kullanılabilir. .
İmza:
readonly passwordSalt?: string;
UserRecord.phoneNumber
Ayarlanmışsa kullanıcının birincil telefon numarası.
İmza:
readonly phoneNumber?: string;
UserRecord.photoURL
Kullanıcının fotoğraf URL'si.
İmza:
readonly photoURL?: string;
UserRecord.providerData
Kullanıcıya bağlı bir dizi sağlayıcı (örneğin, Google, Facebook).
İmza:
readonly providerData: UserInfo[];
UserRecord.tenantId
Varsa, kullanıcının ait olduğu kiracının kimliği.
İmza:
readonly tenantId?: string | null;
UserRecord.tokensValidAfterTime
Kullanıcının belirteçlerinin geçerli olacağı tarih, UTC dizesi olarak biçimlendirilmiştir. Bu, kullanıcının yenileme jetonunun BaseAuth.revokeRefreshTokens() API'sinden veya Firebase Auth arka ucundan büyük hesap değişikliklerinde (şifre sıfırlama, şifre veya e-posta güncellemeleri vb.) her iptal edilişinde güncellenir.
İmza:
readonly tokensValidAfterTime?: string;
UserRecord.uid
Kullanıcının kullanıcı uid
.
İmza:
readonly uid: string;
UserRecord.toJSON()
Bu nesnenin JSON ile seri hale getirilebilir gösterimini döndürür.
İmza:
toJSON(): object;
İadeler:
nesne
Bu nesnenin JSON ile serileştirilebilir temsili.