使用者帳戶。
Signature:
export interface User extends UserInfo
擴充： UserInfo
屬性
| 屬性 | 類型 | 說明 |
|---|---|---|
| emailVerified | boolean | 電子郵件是否已通過 sendEmailVerification() 和 applyActionCode() 驗證。 |
| isAnonymous | boolean | 使用者是否使用 ProviderId.ANONYMOUS 供應商進行驗證。 |
| 中繼資料 | UserMetadata | 與使用者建立和登入時間有關的其他中繼資料。 |
| providerData | UserInfo[] | 每個供應商提供的額外項目，例如 displayName 和設定檔資訊。 |
| refreshToken | 字串 | 重新整理用來重新驗證使用者的權杖。請避免直接使用，建議改用 User.getIdToken() 更新 ID 權杖。 |
| tenantId | 字串 | 空值 | 使用者的用戶群 ID。 |
方法
| 方法 | 說明 |
|---|---|
| delete() | 刪除使用者並登出。 |
| getIdToken(forceRefresh) | 傳回用於向 Firebase 服務識別使用者的 JSON Web Token (JWT)。 |
| getIdTokenResult(forceRefresh) | 傳回用於識別 Firebase 服務使用者的去序列化 JSON Web Token (JWT)。 |
| reload() | 重新整理使用者 (如果已登入)。 |
| toJSON() | 傳回此物件的 JSON 序列化表示法。 |
User.emailVerified
電子郵件是否已通過 sendEmailVerification() 和 applyActionCode() 驗證。
Signature:
readonly emailVerified: boolean;
User.isAnonymous
使用者是否使用 ProviderId.ANONYMOUS 供應商進行驗證。
Signature:
readonly isAnonymous: boolean;
User.metadata
與使用者建立和登入時間有關的其他中繼資料。
Signature:
readonly metadata: UserMetadata;
User.providerData
每個供應商提供的額外項目，例如 displayName 和設定檔資訊。
Signature:
readonly providerData: UserInfo[];
User.refreshToken
重新整理用來重新驗證使用者的權杖。請避免直接使用，建議改用 User.getIdToken() 更新 ID 權杖。
Signature:
readonly refreshToken: string;
User.tenantId
使用者的用戶群 ID。
這是唯讀屬性，表示用來登入使用者的用戶群 ID。如果使用者從父項專案登入，則為空值。
Signature:
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 執行個體登入的 User 都不支援這個方法。
Signature:
delete(): Promise<void>;
傳回：
Promise<void>
User.getIdToken()
傳回用於向 Firebase 服務識別使用者的 JSON Web Token (JWT)。
如果目前的權杖尚未過期或不會在接下來 5 分鐘內過期，則傳回目前的權杖。否則，系統會重新整理權杖，然後傳回新權杖。
Signature:
getIdToken(forceRefresh?: boolean): Promise<string>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| forceRefresh | boolean | 無論權杖到期時間為何，一律強制重新整理。 |
傳回：
Promise<string>
User.getIdTokenResult()
傳回用於識別 Firebase 服務使用者的去序列化 JSON Web Token (JWT)。
如果目前的權杖尚未過期或不會在接下來 5 分鐘內過期，則傳回目前的權杖。否則，系統會重新整理權杖，然後傳回新權杖。
Signature:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| forceRefresh | boolean | 無論權杖到期時間為何，一律強制重新整理。 |
傳回：
Promise<IdTokenResult>
User.reload()
重新整理使用者 (如果已登入)。
Signature:
reload(): Promise<void>;
傳回：
Promise<void>
User.toJSON()
傳回此物件的 JSON 序列化表示法。
Signature:
toJSON(): object;
傳回：
物件
此物件的 JSON 序列化表示法。