Tài khoản người dùng.
Chữ ký:
export interface User extends UserInfo
Mở rộng: UserInfo
Thuộc tính
| Tài sản | Loại | Mô tả |
|---|---|---|
| emailĐã xác minh | boolean | Liệu email đã được xác minh bằng sendEmailVerify() và applyActionCode() hay chưa. |
| Ẩn danh | boolean | Liệu người dùng có được xác thực bằng nhà cung cấp ProviderId.ANONYMOUS hay không. |
| siêu dữ liệu | Siêu dữ liệu người dùng | Siêu dữ liệu bổ sung về quá trình tạo người dùng và thời gian đăng nhập. |
| providerData | Thông tin người dùng[] | Thông tin bổ sung của mỗi nhà cung cấp như displayName và thông tin hồ sơ. |
| refreshToken | chuỗi | Mã làm mới dùng để xác thực lại người dùng. Thay vào đó, hãy tránh sử dụng trực tiếp và ưu tiên dùng User.getIdToken() để làm mới mã thông báo giá trị nhận dạng. |
| tenantId | chuỗi | rỗng | Mã đối tượng thuê của người dùng. |
Phương thức
| Phương thức | Mô tả |
|---|---|
| delete() | Xoá và đăng xuất người dùng. |
| getIdToken(forceRefresh) | Trả về Mã thông báo web JSON (JWT) dùng để nhận dạng người dùng cho dịch vụ Firebase. |
| getIdTokenResult(forceRefresh) | Trả về Mã thông báo web JSON giải tuần tự (JWT) dùng để xác định người dùng cho dịch vụ Firebase. |
| tải lại() | Làm mới người dùng nếu đã đăng nhập. |
| toJSON() | Trả về một bản trình bày có thể chuyển đổi tuần tự JSON của đối tượng này. |
Người dùng.emailĐã xác minh
Liệu email đã được xác minh bằng sendEmailVerify() và applyActionCode() hay chưa.
Chữ ký:
readonly emailVerified: boolean;
Người dùng ẩn danh
Liệu người dùng có được xác thực bằng nhà cung cấp ProviderId.ANONYMOUS hay không.
Chữ ký:
readonly isAnonymous: boolean;
User.metadata
Siêu dữ liệu bổ sung về quá trình tạo người dùng và thời gian đăng nhập.
Chữ ký:
readonly metadata: UserMetadata;
Dữ liệu người dùng
Thông tin bổ sung của mỗi nhà cung cấp như displayName và thông tin hồ sơ.
Chữ ký:
readonly providerData: UserInfo[];
Mã thông báo User.refresh
Mã làm mới dùng để xác thực lại người dùng. Thay vào đó, hãy tránh sử dụng trực tiếp và ưu tiên dùng User.getIdToken() để làm mới mã thông báo giá trị nhận dạng.
Chữ ký:
readonly refreshToken: string;
Mã User.tenant
Mã đối tượng thuê của người dùng.
Đây là tài sản chỉ có thể đọc, cho biết mã đối tượng thuê được dùng để đăng nhập người dùng. Giá trị này là rỗng nếu người dùng đăng nhập từ dự án mẹ.
Chữ ký:
readonly tenantId: string | null;
Ví dụ
// 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()
Xoá và đăng xuất người dùng.
Phương thức này không được hỗ trợ trên bất cứ Người dùng nào đã đăng nhập bằng các bản sao Xác thực được tạo bằng FirebaseServerApp.
Chữ ký:
delete(): Promise<void>;
Trường hợp trả lại hàng:
Lời hứa<vô hiệu>
Phương thức User.getIdToken()
Trả về Mã thông báo web JSON (JWT) dùng để nhận dạng người dùng cho dịch vụ Firebase.
Trả về mã thông báo hiện tại nếu mã này chưa hết hạn hoặc chưa hết hạn trong 5 phút tiếp theo. Nếu không, thao tác này sẽ làm mới mã thông báo và trả về một mã mới.
Chữ ký:
getIdToken(forceRefresh?: boolean): Promise<string>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Bắt buộc làm mới | boolean | Buộc làm mới bất kể mã thông báo hết hạn. |
Trường hợp trả lại hàng:
Cam kết<string>
User.getIdTokenResult()
Trả về Mã thông báo web JSON giải tuần tự (JWT) dùng để xác định người dùng cho dịch vụ Firebase.
Trả về mã thông báo hiện tại nếu mã này chưa hết hạn hoặc chưa hết hạn trong 5 phút tiếp theo. Nếu không, thao tác này sẽ làm mới mã thông báo và trả về một mã mới.
Chữ ký:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| Bắt buộc làm mới | boolean | Buộc làm mới bất kể mã thông báo hết hạn. |
Trường hợp trả lại hàng:
Cam kết<IdTokenResult>
User.reload()
Làm mới người dùng nếu đã đăng nhập.
Chữ ký:
reload(): Promise<void>;
Trường hợp trả lại hàng:
Lời hứa<vô hiệu>
User.toJSON()
Trả về một bản trình bày có thể chuyển đổi tuần tự JSON của đối tượng này.
Chữ ký:
toJSON(): object;
Trường hợp trả lại hàng:
đối tượng
Một bản trình bày có thể chuyển đổi tuần tự JSON của đối tượng này.