User interface

Kullanıcı hesabı.

İmza:

export interface User extends UserInfo

Kapsamı: UserInfo

Özellikler

Özellik Tür Açıklama
e-posta Doğrulaması boolean E-postanın sendEmail Verification() ve applyActionCode() ile doğrulanıp doğrulanmadığı.
isAnonymous boolean Kullanıcının kimliğinin ProviderId.ANONYMOUS sağlayıcısı kullanılarak doğrulanıp doğrulanmadığı.
meta veriler KullanıcıMeta Verileri Kullanıcı oluşturma ve oturum açma zamanlarıyla ilgili ek meta veriler.
sağlayıcıVerisi Kullanıcı Bilgileri[] DisplayName ve profil bilgileri gibi sağlayıcı başına ek bilgiler.
refreshToken dize Kullanıcının kimliğini tekrar doğrulamak için kullanılan yenileme jetonu. Doğrudan bunu kullanmaktan kaçının ve bunun yerine kimlik jetonunu yenilemek için User.getIdToken() yöntemini tercih edin.
kiracıNo dize | boş Kullanıcının kiracı kimliği.

Yöntemler

Yöntem Açıklama
delete() Kullanıcıyı siler ve oturumu kapatır.
getIdToken(forceRefresh) Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan bir JSON Web Jetonu (JWT) döndürür.
getIdTokenResult(forceRefresh) Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan, seri durumdan çıkarılmış JSON Web Token'ı (JWT) döndürür.
reload() Oturum açmışsa kullanıcıyı yeniler.
toJSON() Bu nesnenin JSON'de seri hale getirilebilir bir temsilini döndürür.

Kullanıcı.e-postasıDoğrulandı

E-postanın sendEmail Verification() ve applyActionCode() ile doğrulanıp doğrulanmadığı.

İmza:

readonly emailVerified: boolean;

Kullanıcı.isAnonim

Kullanıcının kimliğinin ProviderId.ANONYMOUS sağlayıcısı kullanılarak doğrulanıp doğrulanmadığı.

İmza:

readonly isAnonymous: boolean;

User.metadata

Kullanıcı oluşturma ve oturum açma zamanlarıyla ilgili ek meta veriler.

İmza:

readonly metadata: UserMetadata;

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

DisplayName ve profil bilgileri gibi sağlayıcı başına ek bilgiler.

İmza:

readonly providerData: UserInfo[];

User.refreshToken

Kullanıcının kimliğini tekrar doğrulamak için kullanılan yenileme jetonu. Doğrudan bunu kullanmaktan kaçının ve bunun yerine kimlik jetonunu yenilemek için User.getIdToken() yöntemini tercih edin.

İmza:

readonly refreshToken: string;

Kullanıcı.KiracıNo

Kullanıcının kiracı kimliği.

Bu, kullanıcının oturum açmak için kullanılan kiracı kimliğini gösteren salt okunur bir özelliktir. Kullanıcı üst projeden oturum açtıysa bu değer boştur.

İmza:

readonly tenantId: string | null;

Örnek

// 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()

Kullanıcıyı siler ve oturumu kapatır.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından oturum açan hiçbir User için desteklenmez.

İmza:

delete(): Promise<void>;

Şunu döndürür:

Taahhüt<void>

User.getIdToken()

Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan bir JSON Web Jetonu (JWT) döndürür.

Süresi dolmamışsa veya süresi önümüzdeki beş dakika içinde bitmeyecekse mevcut jetonu döndürür. Aksi takdirde, jeton yenilenir ve yeni bir jeton döndürülür.

İmza:

getIdToken(forceRefresh?: boolean): Promise<string>;

Parametreler

Parametre Tür Açıklama
zorla yenileme boolean Jetonun geçerlilik süresi ne olursa olsun zorunlu yenileme.

Şunu döndürür:

Promise<dize>

User.getIdTokenResult()

Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan, seri durumdan çıkarılmış JSON Web Token'ı (JWT) döndürür.

Süresi dolmamışsa veya süresi önümüzdeki beş dakika içinde bitmeyecekse mevcut jetonu döndürür. Aksi takdirde, jeton yenilenir ve yeni bir jeton döndürülür.

İmza:

getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;

Parametreler

Parametre Tür Açıklama
zorla yenileme boolean Jetonun geçerlilik süresi ne olursa olsun zorunlu yenileme.

Şunu döndürür:

Promise<IdTokenResult>

User.reload()

Oturum açmışsa kullanıcıyı yeniler.

İmza:

reload(): Promise<void>;

Şunu döndürür:

Taahhüt<void>

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