一个用户帐户。
签名:
export interface User extends UserInfo
扩展:用户信息
特性
财产 | 类型 | 描述 |
---|---|---|
电子邮件已验证 | 布尔值 | 电子邮件是否已通过sendEmailVerification()和applyActionCode()验证。 |
是匿名的 | 布尔值 | 是否使用ProviderId对用户进行身份验证.匿名提供商。 |
元数据 | 用户元数据 | 有关用户创建和登录时间的其他元数据。 |
提供者数据 | 用户信息[] | 每个提供商的附加信息,例如显示名称和个人资料信息。 |
刷新令牌 | 细绳 | 用于重新验证用户身份的刷新令牌。避免直接使用它,而更喜欢User.getIdToken()来刷新 ID 令牌。 |
租户ID | 字符串|无效的 | 用户的租户 ID。 |
方法
方法 | 描述 |
---|---|
删除() | 删除并注销用户。 |
getIdToken(强制刷新) | 返回用于向 Firebase 服务识别用户的 JSON Web 令牌 (JWT)。 |
getIdTokenResult(强制刷新) | 返回反序列化的 JSON Web 令牌 (JWT),用于向 Firebase 服务识别用户。 |
重新加载() | 如果已登录,则刷新用户。 |
toJSON() | 返回此对象的 JSON 可序列化表示形式。 |
用户.email已验证
电子邮件是否已通过sendEmailVerification()和applyActionCode()验证。
签名:
readonly emailVerified: boolean;
用户.isAnonymous
是否使用ProviderId对用户进行身份验证.匿名提供商。
签名:
readonly isAnonymous: boolean;
用户元数据
有关用户创建和登录时间的其他元数据。
签名:
readonly metadata: UserMetadata;
用户.提供者数据
每个提供商的附加信息,例如显示名称和个人资料信息。
签名:
readonly providerData: UserInfo[];
用户.refreshToken
用于重新验证用户身份的刷新令牌。避免直接使用它,而更喜欢User.getIdToken()来刷新 ID 令牌。
签名:
readonly refreshToken: string;
用户.tenantId
用户的租户 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'.
用户.delete()
删除并注销用户。
签名:
delete(): Promise<void>;
返回:
承诺<无效>
User.getIdToken()
返回用于向 Firebase 服务识别用户的 JSON Web 令牌 (JWT)。
如果当前令牌尚未过期或在接下来的五分钟内不会过期,则返回当前令牌。否则,这将刷新令牌并返回一个新令牌。
签名:
getIdToken(forceRefresh?: boolean): Promise<string>;
参数
范围 | 类型 | 描述 |
---|---|---|
强制刷新 | 布尔值 | 无论令牌是否过期,都强制刷新。 |
返回:
承诺<字符串>
User.getIdTokenResult()
返回反序列化的 JSON Web 令牌 (JWT),用于向 Firebase 服务识别用户。
如果当前令牌尚未过期或在接下来的五分钟内不会过期,则返回当前令牌。否则,这将刷新令牌并返回一个新令牌。
签名:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
参数
范围 | 类型 | 描述 |
---|---|---|
强制刷新 | 布尔值 | 无论令牌是否过期,都强制刷新。 |
返回:
Promise< IdTokenResult >
用户.reload()
如果已登录,则刷新用户。
签名:
reload(): Promise<void>;
返回:
承诺<无效>
用户.toJSON()
返回此对象的 JSON 可序列化表示形式。
签名:
toJSON(): object;
返回:
目的
该对象的 JSON 可序列化表示。