แสดงถึงผู้ใช้
ลายเซ็น:
export declare class UserRecord
คุณสมบัติ
คุณสมบัติ | ตัวดัดแปลง | พิมพ์ | คำอธิบาย |
---|---|---|---|
การเรียกร้องแบบกำหนดเอง | { [คีย์: สตริง]: ใด ๆ; } | ออบเจ็กต์การอ้างสิทธิ์แบบกำหนดเองของผู้ใช้ หากมี โดยทั่วไปจะใช้เพื่อกำหนดบทบาทของผู้ใช้และเผยแพร่ไปยังโทเค็น ID ของผู้ใช้ที่ผ่านการรับรองความถูกต้อง ซึ่งตั้งค่าผ่าน BaseAuth.setCustomUserClaims() | |
พิการ | บูลีน | ผู้ใช้ถูกปิดการใช้งานหรือไม่: true สำหรับการปิดการใช้งาน; false สำหรับการเปิดใช้งาน | |
ชื่อที่แสดง | เชือก | ชื่อที่แสดงของผู้ใช้ | |
อีเมล | เชือก | อีเมลหลักของผู้ใช้ หากตั้งค่าไว้ | |
อีเมลยืนยันแล้ว | บูลีน | อีเมลหลักของผู้ใช้จะได้รับการยืนยันหรือไม่ | |
ข้อมูลเมตา | ข้อมูลเมตาของผู้ใช้ | ข้อมูลเมตาเพิ่มเติมเกี่ยวกับผู้ใช้ | |
หลายปัจจัย | การตั้งค่าหลายปัจจัย | คุณสมบัติที่เกี่ยวข้องกับหลายปัจจัยสำหรับผู้ใช้ปัจจุบัน หากมี | |
รหัสผ่านHash | เชือก | รหัสผ่านที่แฮชของผู้ใช้ (เข้ารหัส base64) เฉพาะในกรณีที่มีการใช้อัลกอริทึมการแฮชของ Firebase Auth (SCRYPT) เท่านั้น หากมีการใช้อัลกอริธึมการแฮชอื่นเมื่ออัปโหลดผู้ใช้รายนี้ ตามปกติเมื่อย้ายจากระบบ Auth อื่น นี่จะเป็นสตริงว่าง หากไม่ได้ตั้งรหัสผ่าน ค่านี้จะถือเป็นโมฆะ ซึ่งจะใช้ได้เฉพาะเมื่อได้รับผู้ใช้จาก BaseAuth.listUsers() . | |
รหัสผ่านSalt | เชือก | Salt รหัสผ่านของผู้ใช้ (เข้ารหัส base64) เฉพาะในกรณีที่ใช้อัลกอริทึมการแฮชของ Firebase Auth (SCRYPT) เท่านั้น หากมีการใช้อัลกอริธึมการแฮชอื่นเพื่ออัปโหลดผู้ใช้รายนี้ โดยทั่วไปเมื่อย้ายจากระบบ Auth อื่น นี่จะเป็นสตริงว่าง หากไม่ได้ตั้งรหัสผ่าน ค่านี้จะถือเป็นโมฆะ ซึ่งจะใช้ได้เฉพาะเมื่อได้รับผู้ใช้จาก BaseAuth.listUsers() . | |
หมายเลขโทรศัพท์ | เชือก | หมายเลขโทรศัพท์หลักของผู้ใช้ หากตั้งค่าไว้ | |
URL รูปภาพ | เชือก | URL รูปภาพของผู้ใช้ | |
ผู้ให้บริการข้อมูล | ข้อมูลผู้ใช้ [] | อาร์เรย์ของผู้ให้บริการ (เช่น Google, Facebook) ที่เชื่อมโยงกับผู้ใช้ | |
รหัสผู้เช่า | สตริง | โมฆะ | ID ของผู้เช่าที่ผู้ใช้เป็นสมาชิก หากมี | |
โทเค็นValidAfterTime | เชือก | วันที่โทเค็นของผู้ใช้จะใช้ได้หลังจากนั้น โดยจัดรูปแบบเป็นสตริง UTC สิ่งนี้จะได้รับการอัปเดตทุกครั้งที่โทเค็นการรีเฟรชของผู้ใช้ถูกเพิกถอนจาก BaseAuth.revoidRefreshTokens() API หรือจากแบ็คเอนด์ Firebase Auth ในการเปลี่ยนแปลงบัญชีจำนวนมาก (การรีเซ็ตรหัสผ่าน รหัสผ่านหรือการอัปเดตอีเมล ฯลฯ) | |
uid | เชือก | uid ของผู้ใช้ |
วิธีการ
วิธี | ตัวดัดแปลง | คำอธิบาย |
---|---|---|
ถึง JSON() | ส่งคืนการแสดงออบเจ็กต์ที่ทำให้เป็นอนุกรม JSON ของออบเจ็กต์นี้ได้ |
UserRecord.customCclaims
ออบเจ็กต์การอ้างสิทธิ์แบบกำหนดเองของผู้ใช้ หากมี โดยทั่วไปจะใช้เพื่อกำหนดบทบาทของผู้ใช้และเผยแพร่ไปยังโทเค็น ID ของผู้ใช้ที่ผ่านการรับรองความถูกต้อง ซึ่งตั้งค่าผ่าน BaseAuth.setCustomUserClaims()
ลายเซ็น:
readonly customClaims?: {
[key: string]: any;
};
UserRecord.disabled
ผู้ใช้ถูกปิดการใช้งานหรือไม่: true
สำหรับการปิดการใช้งาน; false
สำหรับการเปิดใช้งาน
ลายเซ็น:
readonly disabled: boolean;
UserRecord.displayName
ชื่อที่แสดงของผู้ใช้
ลายเซ็น:
readonly displayName?: string;
UserRecord.email
อีเมลหลักของผู้ใช้ หากตั้งค่าไว้
ลายเซ็น:
readonly email?: string;
UserRecord.emailยืนยันแล้ว
อีเมลหลักของผู้ใช้จะได้รับการยืนยันหรือไม่
ลายเซ็น:
readonly emailVerified: boolean;
UserRecord.metadata
ข้อมูลเมตาเพิ่มเติมเกี่ยวกับผู้ใช้
ลายเซ็น:
readonly metadata: UserMetadata;
UserRecord.multiFactor
คุณสมบัติที่เกี่ยวข้องกับหลายปัจจัยสำหรับผู้ใช้ปัจจุบัน หากมี
ลายเซ็น:
readonly multiFactor?: MultiFactorSettings;
UserRecord.passwordHash
รหัสผ่านที่แฮชของผู้ใช้ (เข้ารหัส base64) เฉพาะในกรณีที่มีการใช้อัลกอริทึมการแฮชของ Firebase Auth (SCRYPT) เท่านั้น หากมีการใช้อัลกอริธึมการแฮชอื่นเมื่ออัปโหลดผู้ใช้รายนี้ ตามปกติเมื่อย้ายจากระบบ Auth อื่น นี่จะเป็นสตริงว่าง หากไม่ได้ตั้งรหัสผ่าน ค่านี้จะถือเป็นโมฆะ ซึ่งจะใช้ได้เฉพาะเมื่อได้รับผู้ใช้จาก BaseAuth.listUsers() .
ลายเซ็น:
readonly passwordHash?: string;
UserRecord.passwordSalt
Salt รหัสผ่านของผู้ใช้ (เข้ารหัส base64) เฉพาะในกรณีที่ใช้อัลกอริทึมการแฮชของ Firebase Auth (SCRYPT) เท่านั้น หากมีการใช้อัลกอริธึมการแฮชอื่นเพื่ออัปโหลดผู้ใช้รายนี้ โดยทั่วไปเมื่อย้ายจากระบบ Auth อื่น นี่จะเป็นสตริงว่าง หากไม่ได้ตั้งรหัสผ่าน ค่านี้จะถือเป็นโมฆะ ซึ่งจะใช้ได้เฉพาะเมื่อได้รับผู้ใช้จาก 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
ID ของผู้เช่าที่ผู้ใช้เป็นสมาชิก หากมี
ลายเซ็น:
readonly tenantId?: string | null;
UserRecord.tokensValidAfterTime
วันที่โทเค็นของผู้ใช้จะใช้ได้หลังจากนั้น โดยจัดรูปแบบเป็นสตริง UTC สิ่งนี้จะได้รับการอัปเดตทุกครั้งที่โทเค็นการรีเฟรชของผู้ใช้ถูกเพิกถอนจาก BaseAuth.revoidRefreshTokens() API หรือจากแบ็คเอนด์ Firebase Auth ในการเปลี่ยนแปลงบัญชีจำนวนมาก (การรีเซ็ตรหัสผ่าน รหัสผ่านหรือการอัปเดตอีเมล ฯลฯ)
ลายเซ็น:
readonly tokensValidAfterTime?: string;
UserRecord.uid
uid
ของผู้ใช้ .
ลายเซ็น:
readonly uid: string;
UserRecord.toJSON()
ส่งคืนการแสดงออบเจ็กต์ที่ทำให้เป็นอนุกรม JSON ของออบเจ็กต์นี้ได้
ลายเซ็น:
toJSON(): object;
ผลตอบแทน:
วัตถุ
การแสดงวัตถุนี้แบบอนุกรมได้ JSON