Đại diện cho người dùng.
Chữ ký:
export declare class UserRecord
Thuộc tính
Tài sản | Công cụ sửa đổi | Loại | Mô tả |
---|---|---|---|
custom claims | { [key: string]: any; } | Đối tượng xác nhận quyền sở hữu tuỳ chỉnh của người dùng (nếu có), thường dùng để xác định vai trò của người dùng và được truyền đến mã nhận dạng của người dùng đã được xác thực. Thông tin này được đặt qua BaseAuth.setCustomUser claims() | |
đã tắt | boolean | Liệu người dùng có bị vô hiệu hoá hay không: true cho người dùng bị vô hiệu hoá; Đã bật false . |
|
displayName | chuỗi | Tên hiển thị của người dùng. | |
chuỗi | Email chính của người dùng (nếu có). | ||
emailĐã xác minh | boolean | Email chính của người dùng có được xác minh 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ề người dùng. | |
đa yếu tố | Chế độ cài đặt đa yếu tố | Các thuộc tính liên quan đến đa yếu tố cho người dùng hiện tại (nếu có). | |
passwordHash | chuỗi | Mật khẩu đã băm của người dùng (được mã hoá base64), chỉ khi thuật toán băm xác thực Firebase (SCRYPT) được sử dụng. Nếu bạn đã sử dụng một thuật toán băm khác khi tải người dùng này lên (như thông thường khi di chuyển từ một hệ thống Xác thực khác), thì đây sẽ là một chuỗi trống. Nếu bạn không đặt mật khẩu nào, thì giá trị này sẽ rỗng. Tính năng này chỉ dùng được khi người dùng được lấy từ BaseAuth.listUsers(). | |
passwordSalt | chuỗi | Dữ liệu ngẫu nhiên của mật khẩu của người dùng (được mã hoá base64), chỉ khi thuật toán băm xác thực Firebase (SCRYPT) được sử dụng. Nếu bạn đã dùng một thuật toán băm khác để tải người dùng này lên (thường là khi di chuyển từ một hệ thống Xác thực khác), thì đây sẽ là một chuỗi trống. Nếu bạn không đặt mật khẩu nào, thì giá trị này sẽ rỗng. Tính năng này chỉ dùng được khi người dùng được lấy từ BaseAuth.listUsers(). | |
phoneNumber | chuỗi | Số điện thoại chính của người dùng, nếu có. | |
photoURL | chuỗi | URL ảnh của người dùng. | |
providerData | Thông tin người dùng[] | Một loạt nhà cung cấp (ví dụ: Google, Facebook) được liên kết với người dùng. | |
tenantId | chuỗi | rỗng | Mã của đối tượng thuê nơi có người dùng, nếu có. | |
tokensValidSau thời gian | chuỗi | Ngày mà mã thông báo của người dùng có hiệu lực sau đó, được định dạng dưới dạng chuỗi UTC. Mã này được cập nhật mỗi khi mã làm mới của người dùng bị thu hồi từ API BaseAuth.RevokeRefreshTokens() hoặc từ phần phụ trợ Xác thực Firebase đối với các thay đổi lớn đối với tài khoản (đặt lại mật khẩu, cập nhật mật khẩu hoặc email, v.v.). | |
uid | chuỗi | uid của người dùng. |
Phương thức
Phương thức | Công cụ sửa đổi | Mô tả |
---|---|---|
toJSON() | Trả về 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 Hồ sơ.custom tuỳ chỉnh
Đối tượng xác nhận quyền sở hữu tuỳ chỉnh của người dùng (nếu có), thường dùng để xác định vai trò của người dùng và được truyền đến mã nhận dạng của người dùng đã được xác thực. Thông tin này được đặt qua BaseAuth.setCustomUser claims()
Chữ ký:
readonly customClaims?: {
[key: string]: any;
};
UserRecord.disabled
Liệu người dùng có bị vô hiệu hoá hay không: true
cho người dùng bị vô hiệu hoá; Đã bật false
.
Chữ ký:
readonly disabled: boolean;
UserRecord.displayName
Tên hiển thị của người dùng.
Chữ ký:
readonly displayName?: string;
Hồ sơ người dùng.email
Email chính của người dùng (nếu có).
Chữ ký:
readonly email?: string;
UserRecord.emailĐã xác minh
Email chính của người dùng có được xác minh hay không.
Chữ ký:
readonly emailVerified: boolean;
UserRecord.metadata
Siêu dữ liệu bổ sung về người dùng.
Chữ ký:
readonly metadata: UserMetadata;
UserRecord.multiFactor
Các thuộc tính liên quan đến đa yếu tố cho người dùng hiện tại (nếu có).
Chữ ký:
readonly multiFactor?: MultiFactorSettings;
Hàm UserRecord.passwordHash
Mật khẩu đã băm của người dùng (được mã hoá base64), chỉ khi thuật toán băm xác thực Firebase (SCRYPT) được sử dụng. Nếu bạn đã sử dụng một thuật toán băm khác khi tải người dùng này lên (như thông thường khi di chuyển từ một hệ thống Xác thực khác), thì đây sẽ là một chuỗi trống. Nếu bạn không đặt mật khẩu nào, thì giá trị này sẽ rỗng. Tính năng này chỉ dùng được khi người dùng được lấy từ BaseAuth.listUsers().
Chữ ký:
readonly passwordHash?: string;
UserRecord.passwordSalt
Dữ liệu ngẫu nhiên của mật khẩu của người dùng (được mã hoá base64), chỉ khi thuật toán băm xác thực Firebase (SCRYPT) được sử dụng. Nếu bạn đã dùng một thuật toán băm khác để tải người dùng này lên (thường là khi di chuyển từ một hệ thống Xác thực khác), thì đây sẽ là một chuỗi trống. Nếu bạn không đặt mật khẩu nào, thì giá trị này sẽ rỗng. Tính năng này chỉ dùng được khi người dùng được lấy từ BaseAuth.listUsers().
Chữ ký:
readonly passwordSalt?: string;
Số người dùng ghi.phone
Số điện thoại chính của người dùng, nếu có.
Chữ ký:
readonly phoneNumber?: string;
Người dùngRecord.photoURL
URL ảnh của người dùng.
Chữ ký:
readonly photoURL?: string;
Dữ liệu người dùng
Một loạt nhà cung cấp (ví dụ: Google, Facebook) được liên kết với người dùng.
Chữ ký:
readonly providerData: UserInfo[];
Mã UserRecord.tenant
Mã của đối tượng thuê nơi có người dùng, nếu có.
Chữ ký:
readonly tenantId?: string | null;
UserRecord.tokensValidSau thời gian
Ngày mà mã thông báo của người dùng có hiệu lực sau đó, được định dạng dưới dạng chuỗi UTC. Mã này được cập nhật mỗi khi mã làm mới của người dùng bị thu hồi từ API BaseAuth.RevokeRefreshTokens() hoặc từ phần phụ trợ Xác thực Firebase đối với các thay đổi lớn đối với tài khoản (đặt lại mật khẩu, cập nhật mật khẩu hoặc email, v.v.).
Chữ ký:
readonly tokensValidAfterTime?: string;
UserRecord.uid
uid
của người dùng.
Chữ ký:
readonly uid: string;
UserRecord.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.