UserRecord class

Đại diện cho một người dùng.

Chữ ký:

export declare class UserRecord 

Của cải

Tài sản sửa đổi Kiểu Sự miêu tả
tùy chỉnhYêu cầu bồi thường { [khóa: chuỗi]: bất kỳ; } Đối tượng xác nhận quyền sở hữu tùy chỉnh của người dùng nếu có, thường được sử dụng để xác định vai trò của người dùng và được truyền tới mã thông báo ID của người dùng đã được xác thực. Điều này được đặt thông qua BaseAuth.setCustomUserClaims()
tàn tật boolean Người dùng có bị vô hiệu hóa hay không: true cho người bị vô hiệu hóa; false để kích hoạt.
tên hiển thị sợi dây Tên hiển thị của người dùng.
e-mail sợi dây Email chính của người dùng, nếu được đặt.
email đã kích hoạt boolean Email chính của người dùng có được xác minh hay không.
metadata 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ố 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ó.
mật khẩu băm sợi dây Mật khẩu băm của người dùng (được mã hóa base64), chỉ khi thuật toán băm Firebase Auth (SCRYPT) được sử dụng. Nếu một thuật toán băm khác đã được sử dụng 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 Auth khác, thì đây sẽ là một chuỗi trống. Nếu không đặt mật khẩu thì đây là giá trị rỗng. Điều này chỉ khả dụng khi người dùng được lấy từ BaseAuth.listUsers() .
mật khẩumuối sợi dây Muối mật khẩu của người dùng (được mã hóa base64), chỉ khi thuật toán băm Firebase Auth (SCRYPT) được sử dụng. Nếu một thuật toán băm khác đã được sử dụng để tải người dùng này lên, điển hình là khi di chuyển từ một hệ thống Auth khác, thì đây sẽ là một chuỗi trống. Nếu không đặt mật khẩu thì đây là giá trị rỗng. Điều này chỉ khả dụng khi người dùng được lấy từ BaseAuth.listUsers() .
số điện thoại sợi dây Số điện thoại chính của người dùng, nếu được đặt.
URL ảnh sợi dây URL ảnh của người dùng.
nhà cung cấpData Thông tin người dùng [] Một loạt các nhà cung cấp (ví dụ: Google, Facebook) được liên kết với người dùng.
id người thuê nhà chuỗi | vô giá trị ID của đối tượng thuê mà người dùng sở hữu, nếu có.
mã thông báoValidAfterTime sợi dây Ngày sau đó mã thông báo của người dùng có hiệu lực, được định dạng dưới dạng chuỗi UTC. Điều này được cập nhật mỗi khi mã thông báo làm mới của người dùng bị thu hồi từ API BaseAuth.revokeRefreshTokens() hoặc từ chương trình phụ trợ Firebase Auth khi có những thay đổi lớn về 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 sợi dây uid của người dùng.

phương pháp

Phương pháp sửa đổi Sự miêu tả
toJSON() Trả về một biểu diễn có thể tuần tự hóa JSON của đối tượng này.

UserRecord.customClaims

Đối tượng xác nhận quyền sở hữu tùy chỉnh của người dùng nếu có, thường được sử dụng để xác định vai trò của người dùng và được truyền tới mã thông báo ID của người dùng đã được xác thực. Điều này được đặt thông qua BaseAuth.setCustomUserClaims()

Chữ ký:

readonly customClaims?: {
        [key: string]: any;
    };

UserRecord.disabled

Người dùng có bị vô hiệu hóa hay không: true cho người bị vô hiệu hóa; false để kích hoạt.

Chữ ký:

readonly disabled: boolean;

UserRecord.displayName

Tên hiển thị của người dùng.

Chữ ký:

readonly displayName?: string;

UserRecord.email

Email chính của người dùng, nếu được đặt.

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;

UserRecord.passwordHash

Mật khẩu băm của người dùng (được mã hóa base64), chỉ khi thuật toán băm Firebase Auth (SCRYPT) được sử dụng. Nếu một thuật toán băm khác đã được sử dụng 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 Auth khác, thì đây sẽ là một chuỗi trống. Nếu không đặt mật khẩu thì đây là giá trị rỗng. Điều này chỉ khả dụng khi người dùng được lấy từ BaseAuth.listUsers() .

Chữ ký:

readonly passwordHash?: string;

UserRecord.passwordSalt

Muối mật khẩu của người dùng (được mã hóa base64), chỉ khi thuật toán băm Firebase Auth (SCRYPT) được sử dụng. Nếu một thuật toán băm khác đã được sử dụng để tải người dùng này lên, điển hình là khi di chuyển từ một hệ thống Auth khác, thì đây sẽ là một chuỗi trống. Nếu không đặt mật khẩu thì đây là giá trị rỗng. Điều này chỉ khả dụng khi người dùng được lấy từ BaseAuth.listUsers() .

Chữ ký:

readonly passwordSalt?: string;

UserRecord.phoneNumber

Số điện thoại chính của người dùng, nếu được đặt.

Chữ ký:

readonly phoneNumber?: string;

UserRecord.photoURL

URL ảnh của người dùng.

Chữ ký:

readonly photoURL?: string;

UserRecord.providerData

Một loạt các nhà cung cấp (ví dụ: Google, Facebook) được liên kết với người dùng.

Chữ ký:

readonly providerData: UserInfo[];

UserRecord.tenantId

ID của đối tượng thuê mà người dùng sở hữu, nếu có.

Chữ ký:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

Ngày sau đó mã thông báo của người dùng có hiệu lực, được định dạng dưới dạng chuỗi UTC. Điều này được cập nhật mỗi khi mã thông báo làm mới của người dùng bị thu hồi từ API BaseAuth.revokeRefreshTokens() hoặc từ chương trình phụ trợ Firebase Auth khi có những thay đổi lớn về 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 biểu diễn có thể tuần tự hóa JSON của đối tượng này.

Chữ ký:

toJSON(): object;

Trả về:

sự vật

Một biểu diễn có thể tuần tự hóa JSON của đối tượng này.