User interface

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 Nội dung mô tả
emailVerified boolean Liệu email đã được xác minh bằng sendEmailVerification()applyActionCode() hay không.
isAnonymous 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 UserMetadata Siêu dữ liệu bổ sung về thời gian tạo người dùng và đăng nhập.
providerData UserInfo[] Thông tin bổ sung cho mỗi nhà cung cấp, chẳng hạn như displayName và thông tin hồ sơ.
refreshToken string Mã làm mới dùng để xác thực lại người dùng. Bạn nên tránh sử dụng trực tiếp mã này và ưu tiên làm mới mã thông báo mã nhận dạng User.getIdToken().
tenantId chuỗi | giá trị rỗng Mã người thuê của người dùng.

Phương thức

Phương thức Nội dung mô tả
delete() Xoá và đăng xuất người dùng.
getIdToken(forceRefresh) Trả về một mã thông báo web JSON (JWT) dùng để nhận dạng người dùng cho một dịch vụ Firebase.
getIdTokenResult(forceRefresh) Trả về mã thông báo web JSON đã giải tuần tự (JWT) được dùng để xác định người dùng cho một dịch vụ Firebase.
reload() Làm mới người dùng, nếu đã đăng nhập.
toJSON() Trả về một giá trị đại diện theo tuần tự JSON của đối tượng này.

User.emailVerified

Liệu email đã được xác minh bằng sendEmailVerification()applyActionCode() hay không.

Chữ ký:

readonly emailVerified: boolean;

User.isAnonymous

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ề thời gian tạo người dùng và đăng nhập.

Chữ ký:

readonly metadata: UserMetadata;

User.providerData

Thông tin bổ sung cho mỗi nhà cung cấp, chẳng hạn như displayName và thông tin hồ sơ.

Chữ ký:

readonly providerData: UserInfo[];

User.refreshToken

Mã làm mới dùng để xác thực lại người dùng. Bạn nên tránh sử dụng trực tiếp mã này và ưu tiên làm mới mã thông báo mã nhận dạng User.getIdToken().

Chữ ký:

readonly refreshToken: string;

User.tenantId

Mã người thuê của người dùng.

Đây là thuộc tính chỉ có thể đọc, cho biết mã người thuê được dùng để đăng nhập cho người dùng. Giá trị này 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 mọi Người dùng đăng nhập bằng thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

delete(): Promise<void>;

Trường hợp trả lại hàng:

Promise<void>

User.getIdToken()

Trả về một mã thông báo web JSON (JWT) dùng để nhận dạng người dùng cho một dịch vụ Firebase.

Trả về mã thông báo hiện tại nếu mã chưa hết hạn hoặc chưa hết hạn sau 5 phút nữa. Nếu không, mã thông báo sẽ được làm mới và trả về một mã mới.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
forceRefresh boolean Buộc làm mới bất kể thời hạn của mã thông báo.

Trường hợp trả lại hàng:

Hứa hẹn<string>

User.getIdTokenResult()

Trả về mã thông báo web JSON đã giải tuần tự (JWT) được dùng để xác định người dùng cho một dịch vụ Firebase.

Trả về mã thông báo hiện tại nếu mã chưa hết hạn hoặc chưa hết hạn sau 5 phút nữa. Nếu không, mã thông báo sẽ được làm mới và trả về một mã mới.

Chữ ký:

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

Tham số

Thông số Loại Nội dung mô tả
forceRefresh boolean Buộc làm mới bất kể thời hạn của mã thông báo.

Trường hợp trả lại hàng:

Promise<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:

Promise<void>

User.toJSON()

Trả về một giá trị đại diện theo 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 giá trị biểu diễn theo tuần tự JSON của đối tượng này.