User interface

Kullanıcı hesabı.

İmza:

export interface User extends UserInfo

Uzantılar: UserInfo

Özellikler

Özellik Tür Açıklama
emailVerified boolean E-postanın sendEmailVerification() ve applyActionCode() işleviyle doğrulanmış olup olmadığı.
isAnonymous boolean Kullanıcının kimliğinin ProviderId.ANONYMOUS sağlayıcısı kullanılarak doğrulanıp doğrulanmadığı.
meta veriler UserMetadata Kullanıcı oluşturma ve oturum açma süreleriyle ilgili ek meta veriler.
providerData UserInfo[] Her sağlayıcı için ektir (ör. displayName ve profil bilgileri).
refreshToken dize Kullanıcının kimliğini yeniden doğrulamak için kullanılan yenileme jetonu. Bunu doğrudan kullanmaktan kaçının ve bunun yerine kimlik jetonunu yenilemek için User.getIdToken() yöntemini tercih edin.
tenantId dize | null Kullanıcının kiracı kimliği.

Yöntemler

Yöntem Açıklama
delete() Kullanıcıyı siler ve kullanıcının oturumunu kapatır.
getIdToken(forceRefresh) Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan 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çılmışsa kullanıcıyı yeniler.
toJSON() Bu nesnenin JSON ile seri hale getirilebilir bir gösterimini döndürür.

User.emailVerified

E-postanın sendEmailVerification() ve applyActionCode() işleviyle doğrulanmış olup olmadığı.

İmza:

readonly emailVerified: boolean;

User.isAnonymous

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 süreleriyle ilgili ek meta veriler.

İmza:

readonly metadata: UserMetadata;

User.providerData

Her sağlayıcı için ektir (ör. displayName ve profil bilgileri).

İmza:

readonly providerData: UserInfo[];

User.refreshToken

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

İmza:

readonly refreshToken: string;

User.tenantId

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 projede 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 kullanıcının oturumunu kapatır.

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

İmza:

delete(): Promise<void>;

İadeler:

Promise<void>

User.getIdToken()

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

Geçerli jetonun süresi dolmamışsa veya sonraki beş dakika içinde süresi dolmayacaksa geçerli 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
forceRefresh boolean Jetonun son kullanma tarihi ne olursa olsun yenilemeye zorla.

İadeler:

Söz<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.

Geçerli jetonun süresi dolmamışsa veya sonraki beş dakika içinde süresi dolmayacaksa geçerli 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
forceRefresh boolean Jetonun son kullanma tarihi ne olursa olsun yenilemeye zorla.

İadeler:

Promise<IdTokenResult>

User.reload()

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

İmza:

reload(): Promise<void>;

İadeler:

Promise<void>

User.toJSON()

Bu nesnenin JSON ile seri hale getirilebilir bir gösterimini döndürür.

İmza:

toJSON(): object;

İadeler:

nesne

Bu nesnenin JSON'da seri hale getirilebilir bir gösterimi.