User interface

使用者帳戶。

簽名:

export interface User extends UserInfo 

擴充項目: UserInfo

屬性

屬性 類型 說明
電子郵件已驗證 布林值 電子郵件是否已使用 sendEmailVerification()applyActionCode() 完成驗證。
匿名 布林值 使用者是否使用 ProviderId.ANONYMOUS 提供者進行驗證。
中繼資料 使用者中繼資料 與使用者建立和登入時間相關的其他中繼資料。
providerData 使用者資訊[] 每個供應商的額外資料,例如 displayName 和個人資料資訊。
refreshToken 字串 更新用來重新驗證使用者的權杖。請避免直接使用這個方法,而是偏好使用 User.getIdToken() 重新整理 ID 權杖。
用戶群 ID 字串 |空值 使用者的用戶群 ID。

方法

方法 說明
delete() 刪除使用者並將其登出。
getIdToken(forceRefresh) 將用來識別使用者的 JSON Web Token (JWT) 傳回 Firebase 服務。
getIdTokenResult(forceRefresh) 傳回用來識別 Firebase 服務使用者的去序列化 JSON Web Token (JWT)。
reload() 在已登入的情況下,重新整理使用者。
toJSON() 傳回此物件的 JSON 可序列化表示法。

已驗證 User.email

電子郵件是否已使用 sendEmailVerification()applyActionCode() 完成驗證。

簽名:

readonly emailVerified: boolean;

User.isAnonymous

使用者是否使用 ProviderId.ANONYMOUS 提供者進行驗證。

簽名:

readonly isAnonymous: boolean;

User.metadata

與使用者建立和登入時間相關的其他中繼資料。

簽名:

readonly metadata: UserMetadata;

使用者.providerData

每個供應商的額外資料,例如 displayName 和個人資料資訊。

簽名:

readonly providerData: UserInfo[];

使用者.refreshToken

更新用來重新驗證使用者的權杖。請避免直接使用這個方法,而是偏好使用 User.getIdToken() 重新整理 ID 權杖。

簽名:

readonly refreshToken: string;

使用者.用戶群 ID

使用者的用戶群 ID。

此為唯讀屬性,指出用來登入使用者的用戶群 ID。如果使用者從上層專案登入,則此內容為空值。

簽名:

readonly tenantId: string | null;

範例

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

刪除使用者並將其登出。

使用者透過 FirebaseServerApp 建立並登入 Auth 執行個體,則不支援此方法。

簽名:

delete(): Promise<void>;

傳回:

承諾<void>

User.getIdToken()

將用來識別使用者的 JSON Web Token (JWT) 傳回 Firebase 服務。

如果目前的權杖並未過期,或將在接下來的五分鐘內失效,系統會傳回目前的權杖。否則,系統會重新整理權杖並傳回新的權杖。

簽名:

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

參數

參數 類型 說明
強制重新整理 布林值 無論權杖過期為何,一律強制重新整理。

傳回:

承諾<字串>

使用者.getIdTokenResult()

傳回用來識別 Firebase 服務使用者的去序列化 JSON Web Token (JWT)。

如果目前的權杖並未過期,或將在接下來的五分鐘內失效,系統會傳回目前的權杖。否則,系統會重新整理權杖並傳回新的權杖。

簽名:

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

參數

參數 類型 說明
強制重新整理 布林值 無論權杖過期為何,一律強制重新整理。

傳回:

Promise<IdTokenResult>

User.reload()

在已登入的情況下,重新整理使用者。

簽名:

reload(): Promise<void>;

傳回:

承諾<void>

使用者.toJSON()

傳回此物件的 JSON 可序列化表示法。

簽名:

toJSON(): object;

傳回:

物件

此物件的 JSON 可序列化表示法。