UserRecord class

แสดงผู้ใช้

ลายเซ็น:

export declare class UserRecord

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ คีย์ตัวปรับแต่ง ประเภท คำอธิบาย
การอ้างสิทธิ์ที่กำหนดเอง { [key: string]: any; } ออบเจ็กต์การอ้างสิทธิ์ที่กำหนดเองของผู้ใช้ (หากมี) โดยปกติจะใช้เพื่อกำหนดบทบาทของผู้ใช้และเผยแพร่เป็นโทเค็น ID ของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว ซึ่งตั้งค่าผ่าน BaseAuth.setCustomUserClaims()
ปิดอยู่ boolean ผู้ใช้ถูกปิดใช้งานหรือไม่: true สำหรับถูกปิดใช้งาน falseสำหรับการเปิดใช้งาน
ชื่อการแสดงผล สตริง ชื่อที่แสดงของผู้ใช้
email สตริง อีเมลหลักของผู้ใช้ หากตั้งค่าไว้
emailVerified boolean อีเมลหลักของผู้ใช้ได้รับการยืนยันหรือไม่
ข้อมูลเมตา ข้อมูลเมตาผู้ใช้ ข้อมูลเมตาเพิ่มเติมเกี่ยวกับผู้ใช้
มัลติแฟกเตอร์ การตั้งค่าแบบหลายปัจจัย พร็อพเพอร์ตี้ที่เกี่ยวข้องกับหลายปัจจัยสำหรับผู้ใช้ปัจจุบัน (หากมี)
passwordHash สตริง รหัสผ่านที่แฮชของผู้ใช้ (เข้ารหัส base64) เฉพาะเมื่อมีการใช้อัลกอริทึมการแฮชของ Firebase Auth (SCRYPT) เท่านั้น หากมีการใช้อัลกอริทึมการแฮชอื่นในการอัปโหลดผู้ใช้รายนี้เหมือนปกติเมื่อย้ายข้อมูลจากระบบการตรวจสอบสิทธิ์อื่น สตริงนี้จะเป็นสตริงว่าง หากไม่ได้ตั้งรหัสผ่านไว้ ค่านี้จะเป็นค่าว่าง โดยจะใช้ได้เมื่อผู้ใช้ได้รับจาก BaseAuth.listUsers() เท่านั้น
passwordSalt สตริง Salt รหัสผ่านของผู้ใช้ (เข้ารหัส base64) เฉพาะเมื่อมีการใช้อัลกอริทึมการแฮช Firebase Auth (SCRYPT) หากมีการใช้อัลกอริทึมการแฮชอื่นเพื่ออัปโหลดผู้ใช้รายนี้ โดยทั่วไปเมื่อย้ายข้อมูลจากระบบการตรวจสอบสิทธิ์อื่น สตริงนี้จะเป็นสตริงว่าง หากไม่ได้ตั้งรหัสผ่านไว้ ค่านี้จะเป็นค่าว่าง โดยจะใช้ได้เมื่อผู้ใช้ได้รับจาก BaseAuth.listUsers() เท่านั้น
หมายเลขโทรศัพท์ สตริง หมายเลขโทรศัพท์หลักของผู้ใช้ หากตั้งค่าไว้
photoURL สตริง URL รูปภาพของผู้ใช้
ผู้ให้บริการข้อมูล ข้อมูลผู้ใช้[] อาร์เรย์ของผู้ให้บริการ (เช่น Google, Facebook) ที่ลิงก์กับผู้ใช้
รหัสกลุ่มผู้ใช้ สตริง | ค่าว่าง รหัสของกลุ่มผู้ใช้ (หากมี)
tokensValidAfterTime สตริง วันที่โทเค็นของผู้ใช้จะใช้ได้หลังจากวันที่ดังกล่าว โดยอยู่ในรูปแบบสตริง UTC ซึ่งจะได้รับการอัปเดตทุกครั้งที่มีการเพิกถอนโทเค็นการรีเฟรชของผู้ใช้จาก BaseAuth.revokeRefreshTokens() API หรือจากแบ็กเอนด์การตรวจสอบสิทธิ์ Firebase เมื่อมีการเปลี่ยนแปลงบัญชีที่สำคัญ (การรีเซ็ตรหัสผ่าน การอัปเดตรหัสผ่าน หรืออีเมล ฯลฯ)
uid สตริง uid ของผู้ใช้

เมธอด

วิธีการ คีย์ตัวปรับแต่ง คำอธิบาย
toJSON() แสดงผลการนำเสนอ JSON แบบอนุกรมของออบเจ็กต์นี้

UserRecord.customClaims

ออบเจ็กต์การอ้างสิทธิ์ที่กำหนดเองของผู้ใช้ (หากมี) โดยปกติจะใช้เพื่อกำหนดบทบาทของผู้ใช้และเผยแพร่เป็นโทเค็น ID ของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว ซึ่งตั้งค่าผ่าน BaseAuth.setCustomUserClaims()

ลายเซ็น:

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

UserRecord.disabled

ผู้ใช้ถูกปิดใช้งานหรือไม่: true สำหรับถูกปิดใช้งาน falseสำหรับการเปิดใช้งาน

ลายเซ็น:

readonly disabled: boolean;

UserRecord.displayName

ชื่อที่แสดงของผู้ใช้

ลายเซ็น:

readonly displayName?: string;

อีเมล UserRecord

อีเมลหลักของผู้ใช้ หากตั้งค่าไว้

ลายเซ็น:

readonly email?: string;

UserRecord.emailVerified แล้ว

อีเมลหลักของผู้ใช้ได้รับการยืนยันหรือไม่

ลายเซ็น:

readonly emailVerified: boolean;

UserRecord.metadata

ข้อมูลเมตาเพิ่มเติมเกี่ยวกับผู้ใช้

ลายเซ็น:

readonly metadata: UserMetadata;

UserRecord.multiFactor

พร็อพเพอร์ตี้ที่เกี่ยวข้องกับหลายปัจจัยสำหรับผู้ใช้ปัจจุบัน (หากมี)

ลายเซ็น:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

รหัสผ่านที่แฮชของผู้ใช้ (เข้ารหัส base64) เฉพาะเมื่อมีการใช้อัลกอริทึมการแฮชของ Firebase Auth (SCRYPT) เท่านั้น หากมีการใช้อัลกอริทึมการแฮชอื่นในการอัปโหลดผู้ใช้รายนี้เหมือนปกติเมื่อย้ายข้อมูลจากระบบการตรวจสอบสิทธิ์อื่น สตริงนี้จะเป็นสตริงว่าง หากไม่ได้ตั้งรหัสผ่านไว้ ค่านี้จะเป็นค่าว่าง โดยจะใช้ได้เมื่อผู้ใช้ได้รับจาก BaseAuth.listUsers() เท่านั้น

ลายเซ็น:

readonly passwordHash?: string;

UserRecord.passwordSalt

Salt รหัสผ่านของผู้ใช้ (เข้ารหัส base64) เฉพาะเมื่อมีการใช้อัลกอริทึมการแฮช Firebase Auth (SCRYPT) หากมีการใช้อัลกอริทึมการแฮชอื่นเพื่ออัปโหลดผู้ใช้รายนี้ โดยทั่วไปเมื่อย้ายข้อมูลจากระบบการตรวจสอบสิทธิ์อื่น สตริงนี้จะเป็นสตริงว่าง หากไม่ได้ตั้งรหัสผ่านไว้ ค่านี้จะเป็นค่าว่าง โดยจะใช้ได้เมื่อผู้ใช้ได้รับจาก BaseAuth.listUsers() เท่านั้น

ลายเซ็น:

readonly passwordSalt?: string;

UserRecord.phoneNumber

หมายเลขโทรศัพท์หลักของผู้ใช้ หากตั้งค่าไว้

ลายเซ็น:

readonly phoneNumber?: string;

UserRecord.photoURL

URL รูปภาพของผู้ใช้

ลายเซ็น:

readonly photoURL?: string;

UserRecord.providerData

อาร์เรย์ของผู้ให้บริการ (เช่น Google, Facebook) ที่ลิงก์กับผู้ใช้

ลายเซ็น:

readonly providerData: UserInfo[];

UserRecord.tenantId

รหัสของกลุ่มผู้ใช้ (หากมี)

ลายเซ็น:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

วันที่โทเค็นของผู้ใช้จะใช้ได้หลังจากวันที่ดังกล่าว โดยอยู่ในรูปแบบสตริง UTC ซึ่งจะได้รับการอัปเดตทุกครั้งที่มีการเพิกถอนโทเค็นการรีเฟรชของผู้ใช้จาก BaseAuth.revokeRefreshTokens() API หรือจากแบ็กเอนด์การตรวจสอบสิทธิ์ Firebase เมื่อมีการเปลี่ยนแปลงบัญชีที่สำคัญ (การรีเซ็ตรหัสผ่าน การอัปเดตรหัสผ่าน หรืออีเมล ฯลฯ)

ลายเซ็น:

readonly tokensValidAfterTime?: string;

UserRecord.uid

uid ของผู้ใช้

ลายเซ็น:

readonly uid: string;

UserRecord.toJSON()

แสดงผลการนำเสนอ JSON แบบอนุกรมของออบเจ็กต์นี้

ลายเซ็น:

toJSON(): object;

การคืนสินค้า:

ออบเจ็กต์

การนำเสนอที่ซีเรียลได้ของ JSON ของออบเจ็กต์นี้